Reflex.Class

Documentation

class (MonadHold t (PushM t), MonadSample t (PullM t), Functor (Event t), Functor (Behavior t)) => Reflex t where

Associated Types

data Behavior t :: * -> *

A container for a value that can change over time. Behaviors can be sampled at will, but it is not possible to be notified when they change

data Event t :: * -> *

A stream of occurrences. During any given frame, an Event is either occurring or not occurring; if it is occurring, it will contain a value of the given type (its "occurrence type")

type PushM t :: * -> *

A monad for doing complex push-based calculations efficiently

type PullM t :: * -> *

A monad for doing complex pull-based calculations efficiently

Methods

never :: Event t a

An Event with no occurrences

constant :: a -> Behavior t a

Create a Behavior that always has the given value

push :: (a -> PushM t (Maybe b)) -> Event t a -> Event t b

Create an Event from another Event; the provided function can sample Behaviors and hold Events, and use the results to produce a occurring (Just) or non-occurring (Nothing) result

pull :: PullM t a -> Behavior t a

Create a Behavior by reading from other Behaviors; the result will be recomputed whenever any of the read Behaviors changes

merge :: GCompare k => DMap (WrapArg (Event t) k) -> Event t (DMap k)

Merge a collection of events; the resulting Event will only occur if at least one input event is occuring, and will contain all of the input keys that are occurring simultaneously

fan :: GCompare k => Event t (DMap k) -> EventSelector t k

Efficiently fan-out an event to many destinations. This function should be partially applied, and then the result applied repeatedly to create child events

switch :: Behavior t (Event t a) -> Event t a

Create an Event that will occur whenever the currently-selected input Event occurs

coincidence :: Event t (Event t a) -> Event t a

Create an Event that will occur whenever the input event is occurring and its occurrence value, another Event, is also occurring

Instances

Reflex Spider

class Monad m => MonadSample t m | m -> t where

Methods

sample :: Behavior t a -> m a

Get the current value in the Behavior

Instances

MonadSample Spider SpiderHostFrame

MonadSample Spider SpiderHost

MonadSample Spider EventM

MonadSample Spider BehaviorM

MonadSample t m => MonadSample t (ReaderT r m)

class MonadSample t m => MonadHold t m where

Methods

hold :: a -> Event t a -> m (Behavior t a)

Create a new Behavior whose value will initially be equal to the given value and will be updated whenever the given Event occurs

Instances

MonadHold Spider SpiderHostFrame

MonadHold Spider SpiderHost

MonadHold Spider EventM

MonadHold t m => MonadHold t (ReaderT r m)

newtype EventSelector t k

Constructors

EventSelector

Fields

select :: forall a. k a -> Event t a

pushAlways :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b

ffor :: Functor f => f a -> (a -> b) -> f b

class FunctorMaybe f where

Methods

fmapMaybe :: (a -> Maybe b) -> f a -> f b

Instances

Reflex t => FunctorMaybe (Event t)

fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b

ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a

zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)

tag :: Reflex t => Behavior t b -> Event t a -> Event t b

Replace the occurrence value of the Event with the value of the Behavior at the time of the occurrence

attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c

attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c

attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)

onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)

headE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)

tailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)

headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)

splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)

traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a

traceEventWith :: Reflex t => (a -> String) -> Event t a -> Event t a

data EitherTag l r a where

Constructors

LeftTag :: EitherTag l r l

RightTag :: EitherTag l r r

Instances

GCompare * (EitherTag l r)

GEq * (EitherTag l r)

(Show l, Show r) => ShowTag (EitherTag l r)

GShow (EitherTag l r)

eitherToDSum :: Either a b -> DSum (EitherTag a b)

dsumToEither :: DSum (EitherTag a b) -> Either a b

dmapToThese :: DMap (EitherTag a b) -> Maybe (These a b)

appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a

sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)

mergeWith :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a

leftmost :: Reflex t => [Event t a] -> Event t a

mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)

mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)

fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)

switchPromptly :: forall t m a. (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)

Switches to the new event whenever it receives one; the new event is used immediately, on the same frame that it is switched to

gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a