Reflex.Dynamic

Basics

data family Dynamic t :: * -> *

A container for a value that can change over time and allows notifications on changes. Basically a combination of a Behavior and an Event, with a rule that the Behavior will change if and only if the Event fires.

Instances

Reflex t => Accumulator (t :: k) (Dynamic t)

Defined in Reflex.Class

Methods

accum :: (MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Dynamic t a)

accumM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Dynamic t a)

accumMaybe :: (MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Dynamic t a)

accumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Dynamic t a)

mapAccum :: (MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)

mapAccumM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)

mapAccumMaybe :: (MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Dynamic t a, Event t c)

mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Dynamic t a, Event t c)

Monad (Dynamic (Pure t))

Defined in Reflex.Pure

Methods

(>>=) :: Dynamic (Pure t) a -> (a -> Dynamic (Pure t) b) -> Dynamic (Pure t) b

(>>) :: Dynamic (Pure t) a -> Dynamic (Pure t) b -> Dynamic (Pure t) b

return :: a -> Dynamic (Pure t) a

fail :: String -> Dynamic (Pure t) a

Monad (Dynamic t) => Monad (Dynamic (ProfiledTimeline t))

Defined in Reflex.Profiled

Methods

(>>=) :: Dynamic (ProfiledTimeline t) a -> (a -> Dynamic (ProfiledTimeline t) b) -> Dynamic (ProfiledTimeline t) b

(>>) :: Dynamic (ProfiledTimeline t) a -> Dynamic (ProfiledTimeline t) b -> Dynamic (ProfiledTimeline t) b

return :: a -> Dynamic (ProfiledTimeline t) a

fail :: String -> Dynamic (ProfiledTimeline t) a

HasSpiderTimeline x => Monad (Dynamic (SpiderTimeline x))

Defined in Reflex.Spider.Internal

Methods

(>>=) :: Dynamic (SpiderTimeline x) a -> (a -> Dynamic (SpiderTimeline x) b) -> Dynamic (SpiderTimeline x) b

(>>) :: Dynamic (SpiderTimeline x) a -> Dynamic (SpiderTimeline x) b -> Dynamic (SpiderTimeline x) b

return :: a -> Dynamic (SpiderTimeline x) a

fail :: String -> Dynamic (SpiderTimeline x) a

Functor (Dynamic (Pure t))

Defined in Reflex.Pure

Methods

fmap :: (a -> b) -> Dynamic (Pure t) a -> Dynamic (Pure t) b

(<$) :: a -> Dynamic (Pure t) b -> Dynamic (Pure t) a

Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))

Defined in Reflex.Profiled

Methods

fmap :: (a -> b) -> Dynamic (ProfiledTimeline t) a -> Dynamic (ProfiledTimeline t) b

(<$) :: a -> Dynamic (ProfiledTimeline t) b -> Dynamic (ProfiledTimeline t) a

HasSpiderTimeline x => Functor (Dynamic (SpiderTimeline x))

Defined in Reflex.Spider.Internal

Methods

fmap :: (a -> b) -> Dynamic (SpiderTimeline x) a -> Dynamic (SpiderTimeline x) b

(<$) :: a -> Dynamic (SpiderTimeline x) b -> Dynamic (SpiderTimeline x) a

Applicative (Dynamic (Pure t))

Defined in Reflex.Pure

Methods

pure :: a -> Dynamic (Pure t) a

(<*>) :: Dynamic (Pure t) (a -> b) -> Dynamic (Pure t) a -> Dynamic (Pure t) b

liftA2 :: (a -> b -> c) -> Dynamic (Pure t) a -> Dynamic (Pure t) b -> Dynamic (Pure t) c

(*>) :: Dynamic (Pure t) a -> Dynamic (Pure t) b -> Dynamic (Pure t) b

(<*) :: Dynamic (Pure t) a -> Dynamic (Pure t) b -> Dynamic (Pure t) a

Applicative (Dynamic t) => Applicative (Dynamic (ProfiledTimeline t))

Defined in Reflex.Profiled

Methods

pure :: a -> Dynamic (ProfiledTimeline t) a

(<*>) :: Dynamic (ProfiledTimeline t) (a -> b) -> Dynamic (ProfiledTimeline t) a -> Dynamic (ProfiledTimeline t) b

liftA2 :: (a -> b -> c) -> Dynamic (ProfiledTimeline t) a -> Dynamic (ProfiledTimeline t) b -> Dynamic (ProfiledTimeline t) c

(*>) :: Dynamic (ProfiledTimeline t) a -> Dynamic (ProfiledTimeline t) b -> Dynamic (ProfiledTimeline t) b

(<*) :: Dynamic (ProfiledTimeline t) a -> Dynamic (ProfiledTimeline t) b -> Dynamic (ProfiledTimeline t) a

HasSpiderTimeline x => Applicative (Dynamic (SpiderTimeline x))

Defined in Reflex.Spider.Internal

Methods

pure :: a -> Dynamic (SpiderTimeline x) a

(<*>) :: Dynamic (SpiderTimeline x) (a -> b) -> Dynamic (SpiderTimeline x) a -> Dynamic (SpiderTimeline x) b

liftA2 :: (a -> b -> c) -> Dynamic (SpiderTimeline x) a -> Dynamic (SpiderTimeline x) b -> Dynamic (SpiderTimeline x) c

(*>) :: Dynamic (SpiderTimeline x) a -> Dynamic (SpiderTimeline x) b -> Dynamic (SpiderTimeline x) b

(<*) :: Dynamic (SpiderTimeline x) a -> Dynamic (SpiderTimeline x) b -> Dynamic (SpiderTimeline x) a

(Num a, Reflex t) => Num (Dynamic t a)

Defined in Reflex.Class

Methods

(+) :: Dynamic t a -> Dynamic t a -> Dynamic t a

(-) :: Dynamic t a -> Dynamic t a -> Dynamic t a

(*) :: Dynamic t a -> Dynamic t a -> Dynamic t a

negate :: Dynamic t a -> Dynamic t a

abs :: Dynamic t a -> Dynamic t a

signum :: Dynamic t a -> Dynamic t a

fromInteger :: Integer -> Dynamic t a

(Reflex t, IsString a) => IsString (Dynamic t a)

Defined in Reflex.Class

Methods

fromString :: String -> Dynamic t a

(Reflex t, Semigroup a) => Semigroup (Dynamic t a)

Defined in Reflex.Class

Methods

(<>) :: Dynamic t a -> Dynamic t a -> Dynamic t a

sconcat :: NonEmpty (Dynamic t a) -> Dynamic t a

stimes :: Integral b => b -> Dynamic t a -> Dynamic t a

(Reflex t, Monoid a) => Monoid (Dynamic t a)

Defined in Reflex.Class

Methods

mempty :: Dynamic t a

mappend :: Dynamic t a -> Dynamic t a -> Dynamic t a

mconcat :: [Dynamic t a] -> Dynamic t a

(Reflex t, Default a) => Default (Dynamic t a)

Defined in Reflex.Class

Methods

def :: Dynamic t a

data Dynamic (Pure t :: *) a

Defined in Reflex.Pure

data Dynamic (Pure t :: *) a = Dynamic {

• unDynamic :: t -> (a, Maybe a)

}

data Dynamic (ProfiledTimeline t :: *) a

Defined in Reflex.Profiled

data Dynamic (ProfiledTimeline t :: *) a = Dynamic_Profiled {

• unDynamic_Profiled :: Dynamic t a

}

data Dynamic (SpiderTimeline x :: *) a

Defined in Reflex.Spider.Internal

data Dynamic (SpiderTimeline x :: *) a = SpiderDynamic {

• unSpiderDynamic :: Dynamic x (Identity a)

}

current :: Reflex t => Dynamic t a -> Behavior t a

Extract the Behavior of a Dynamic.

updated :: Reflex t => Dynamic t a -> Event t a

Extract the Event of the Dynamic.

holdDyn :: MonadHold t m => a -> Event t a -> m (Dynamic t a)

Create a Dynamic value using the given initial value that changes every time the Event occurs.

mapDynM :: forall t m a b. (Reflex t, MonadHold t m) => (forall m'. MonadSample t m' => a -> m' b) -> Dynamic t a -> m (Dynamic t b)

Map a sampling function over a Dynamic.

forDynM :: forall t m a b. (Reflex t, MonadHold t m) => Dynamic t a -> (forall m'. MonadSample t m' => a -> m' b) -> m (Dynamic t b)

Flipped version of mapDynM

constDyn :: Reflex t => a -> Dynamic t a

Construct a Dynamic value that never changes

count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)

Create a new Dynamic that counts the occurrences of the Event.

toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)

Create a new Dynamic using the initial value that flips its value every time the Event occurs.

switchDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a

Switches to the new Event whenever it receives one. Only the old event is considered the moment a new one is switched in; the output event will fire at that moment if only if the old event does.

Prefer this to switchPromptlyDyn where possible. The lack of doing double work when the outer and (new) inner fires means this imposes fewer "timing requirements" and thus is far more easy to use without introducing fresh failure cases. switchDyn is also more performant.

switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a

Switches to the new Event whenever it receives one. Switching occurs before the inner Event fires - so if the Dynamic changes and both the old and new inner Events fire simultaneously, the output will fire with the value of the new Event.

Prefer switchDyn to this where possible. The timing requirements that switching before imposes are likely to bring down your app unless you are very careful. switchDyn is also more performant.

tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a

Replace the value of the Event with the current value of the Dynamic each time the Event occurs.

Note: tagPromptlyDyn d e differs from tag (current d) e in the case that e is firing at the same time that d is changing. With tagPromptlyDyn d e, the new value of d will replace the value of e, whereas with tag (current d) e, the old value will be used, since the Behavior won't be updated until the end of the frame. Additionally, this means that the output Event may not be used to directly change the input Dynamic, because that would mean its value depends on itself. When creating cyclic data flows, generally tag (current d) e is preferred.

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

Attach the current value of the Dynamic to the value of the Event each time it occurs.

Note: attachPromptlyDyn d is not the same as attach (current d). See tagPromptlyDyn for details.

attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c

Combine the current value of the Dynamic with the value of the Event each time it occurs.

Note: attachPromptlyDynWith f d is not the same as attachWith f (current d). See tagPromptlyDyn for details.

attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c

Create a new Event by combining the value at each occurrence with the current value of the Dynamic value and possibly filtering if the combining function returns Nothing.

Note: attachPromptlyDynWithMaybe f d is not the same as attachWithMaybe f (current d). See tagPromptlyDyn for details.

maybeDyn :: forall t a m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe (Dynamic t a)))

Factor a Dynamic t (Maybe a) into a Dynamic t (Maybe (Dynamic t a)), such that the outer Dynamic is updated only when the Maybe's constructor chages from Nothing to Just or vice-versa. Whenever the constructor becomes Just, an inner Dynamic will be provided, whose value will track the a inside the Just; when the constructor becomes Nothing, the existing inner Dynamic will become constant, and will not change when the outer constructor changes back to Nothing.

eitherDyn :: forall t a b m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Either a b) -> m (Dynamic t (Either (Dynamic t a) (Dynamic t b)))

factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k) => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))

scanDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b) -> (a -> b -> b) -> Dynamic t a -> m (Dynamic t b)

Create a Dynamic that accumulates values from another Dynamic. This function does not force its input Dynamic until the output Dynamic is forced.

scanDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b) -> (a -> b -> Maybe b) -> Dynamic t a -> m (Dynamic t b)

Like scanDyn, but the the accumulator function may decline to update the result Dynamic's value.

holdUniqDyn :: (Reflex t, MonadHold t m, MonadFix m, Eq a) => Dynamic t a -> m (Dynamic t a)

Create a new Dynamic that only signals changes if the values actually changed.

holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)

Create a new Dynamic that changes only when the underlying Dynamic changes and the given function returns False when given both the old and the new values.

improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))

Dynamic Maybe that can only update from Nothing to Just or Just to Just (i.e., cannot revert to Nothing)

foldDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> b) -> b -> Event t a -> m (Dynamic t b)

Create a Dynamic using the initial value and change it each time the Event occurs using a folding function on the previous value and the value of the Event.

foldDynM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t b) -> b -> Event t a -> m (Dynamic t b)

Like foldDyn, but the combining function is a PushM action, so it can sample existing Behaviors and hold new ones.

foldDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe b) -> b -> Event t a -> m (Dynamic t b)

Create a Dynamic using the provided initial value and change it each time the provided Event occurs, using a function to combine the old value with the Event's value. If the function returns Nothing, the value is not changed; this is distinct from returning Just the old value, since the Dynamic's updated Event will fire in the Just case, and will not fire in the Nothing case.

foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)

Like foldDynMaybe, but the combining function is a PushM action, so it can sample existing Behaviors and hold new ones.

joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)

Combine a Dynamic of a Map of Dynamics into a Dynamic with the current values of the Dynamics in a map.

traceDyn :: (Reflex t, Show a) => String -> Dynamic t a -> Dynamic t a

Print the value of the Dynamic when it is first read and on each subsequent change that is observed (as traceEvent), prefixed with the provided string. This should only be used for debugging.

Note: Just like Debug.Trace.trace, the value will only be shown if something else in the system is depending on it.

traceDynWith :: Reflex t => (a -> String) -> Dynamic t a -> Dynamic t a

Print the result of applying the provided function to the value of the Dynamic when it is first read and on each subsequent change that is observed (as traceEvent). This should only be used for debugging.

Note: Just like Debug.Trace.trace, the value will only be shown if something else in the system is depending on it.

splitDynPure :: Reflex t => Dynamic t (a, b) -> (Dynamic t a, Dynamic t b)

Split a Dynamic pair into a pair of Dynamics

distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)

Convert a Map with Dynamic elements into a Dynamic of a Map with non-Dynamic elements.

distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)

This function converts a DMap whose elements are Dynamics into a Dynamic DMap. Its implementation is more efficient than doing the same through the use of multiple uses of zipDynWith or Applicative operators.

distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]

Convert a list with Dynamic elements into a Dynamic of a list with non-Dynamic elements, preserving the order of the elements.

data Demux t k

Represents a time changing value together with an EventSelector that can efficiently detect when the underlying Dynamic has a particular value. This is useful for representing data like the current selection of a long list.

Semantically,

demuxed (demux d) k === fmap (== k) d

However, when getDemuxed is used multiple times, the complexity is only O(log(n)), rather than O(n) for fmap.

demux :: (Reflex t, Ord k) => Dynamic t k -> Demux t k

Demultiplex an input value to a Demux with many outputs. At any given time, whichever output is indicated by the given Dynamic will be True.

demuxed :: (Reflex t, Eq k) => Demux t k -> k -> Dynamic t Bool

Select a particular output of the Demux; this is equivalent to (but much faster than) mapping over the original Dynamic and checking whether it is equal to the given key.

Miscellaneous

data HList (l :: [*]) where

A heterogeneous list whose type and length are fixed statically. This is reproduced from the HList package due to integration issues, and because very little other functionality from that library is needed.

Constructors

HNil :: HList '[]

HCons :: e -> HList l -> HList (e ': l) infixr 2

data FHList f l where

Like HList, but with a functor wrapping each element.

Constructors

FHNil :: FHList f '[]

FHCons :: f e -> FHList f l -> FHList f (e ': l)

collectDynPure :: (RebuildSortedHList (HListElems b), IsHList a, IsHList b, AllAreFunctors (Dynamic t) (HListElems b), Reflex t, HListElems a ~ FunctorList (Dynamic t) (HListElems b)) => a -> Dynamic t b

Convert a datastructure whose constituent parts are all Dynamics into a single Dynamic whose value represents all the current values of the input's constituent Dynamics.

class RebuildSortedHList l where

This class allows HLists and FHlists to be built from regular lists; they must be contiguous and sorted.

Minimal complete definition

rebuildSortedFHList, rebuildSortedHList

Methods

rebuildSortedFHList :: [DSum (HListPtr l) f] -> FHList f l

rebuildSortedHList :: [DSum (HListPtr l) Identity] -> HList l

Instances

RebuildSortedHList ([] :: [*])

Defined in Reflex.Dynamic

Methods

rebuildSortedFHList :: [DSum (HListPtr []) f] -> FHList f []

rebuildSortedHList :: [DSum (HListPtr []) Identity] -> HList []

RebuildSortedHList t => RebuildSortedHList (h ': t)

Defined in Reflex.Dynamic

Methods

rebuildSortedFHList :: [DSum (HListPtr (h ': t)) f] -> FHList f (h ': t)

rebuildSortedHList :: [DSum (HListPtr (h ': t)) Identity] -> HList (h ': t)

class IsHList a where

Poor man's Generics for product types only.

Minimal complete definition

toHList, fromHList

Associated Types

type HListElems a :: [*]

Methods

toHList :: a -> HList (HListElems a)

fromHList :: HList (HListElems a) -> a

Instances

IsHList (a, b)

Defined in Reflex.Dynamic

Associated Types

type HListElems (a, b) :: [*]

Methods

toHList :: (a, b) -> HList (HListElems (a, b))

fromHList :: HList (HListElems (a, b)) -> (a, b)

IsHList (a, b, c, d)

Defined in Reflex.Dynamic

Associated Types

type HListElems (a, b, c, d) :: [*]

Methods

toHList :: (a, b, c, d) -> HList (HListElems (a, b, c, d))

fromHList :: HList (HListElems (a, b, c, d)) -> (a, b, c, d)

IsHList (a, b, c, d, e, f)

Defined in Reflex.Dynamic

Associated Types

type HListElems (a, b, c, d, e, f) :: [*]

Methods

toHList :: (a, b, c, d, e, f) -> HList (HListElems (a, b, c, d, e, f))

fromHList :: HList (HListElems (a, b, c, d, e, f)) -> (a, b, c, d, e, f)

class AllAreFunctors (f :: a -> *) (l :: [a]) where

Indicates that all elements in a type-level list are applications of the same functor.

Minimal complete definition

toFHList, fromFHList

Associated Types

type FunctorList f l :: [*]

Methods

toFHList :: HList (FunctorList f l) -> FHList f l

fromFHList :: FHList f l -> HList (FunctorList f l)

Instances

AllAreFunctors (f :: a -> *) ([] :: [a])

Defined in Reflex.Dynamic

Associated Types

type FunctorList f [] :: [*]

Methods

toFHList :: HList (FunctorList f []) -> FHList f []

fromFHList :: FHList f [] -> HList (FunctorList f [])

AllAreFunctors f t => AllAreFunctors (f :: a -> *) (h ': t :: [a])

Defined in Reflex.Dynamic

Associated Types

type FunctorList f (h ': t) :: [*]

Methods

toFHList :: HList (FunctorList f (h ': t)) -> FHList f (h ': t)

fromFHList :: FHList f (h ': t) -> HList (FunctorList f (h ': t))

data HListPtr l a where

A typed index into a typed heterogeneous list.

Constructors

HHeadPtr :: HListPtr (h ': t) h

HTailPtr :: HListPtr t a -> HListPtr (h ': t) a

Instances

GCompare (HListPtr l :: k -> *)

Defined in Reflex.Dynamic

Methods

gcompare :: HListPtr l a -> HListPtr l b -> GOrdering a b

GEq (HListPtr l :: k -> *)

Defined in Reflex.Dynamic

Methods

geq :: HListPtr l a -> HListPtr l b -> Maybe (a := b)

Eq (HListPtr l a2)

Defined in Reflex.Dynamic

Methods

(==) :: HListPtr l a2 -> HListPtr l a2 -> Bool

(/=) :: HListPtr l a2 -> HListPtr l a2 -> Bool

Ord (HListPtr l a2)

Defined in Reflex.Dynamic

Methods

compare :: HListPtr l a2 -> HListPtr l a2 -> Ordering

(<) :: HListPtr l a2 -> HListPtr l a2 -> Bool

(<=) :: HListPtr l a2 -> HListPtr l a2 -> Bool

(>) :: HListPtr l a2 -> HListPtr l a2 -> Bool

(>=) :: HListPtr l a2 -> HListPtr l a2 -> Bool

max :: HListPtr l a2 -> HListPtr l a2 -> HListPtr l a2

min :: HListPtr l a2 -> HListPtr l a2 -> HListPtr l a2

distributeFHListOverDynPure :: (Reflex t, RebuildSortedHList l) => FHList (Dynamic t) l -> Dynamic t (HList l)

Collect a hetereogeneous list whose elements are all Dynamics into a single Dynamic whose value represents the current values of all of the input Dynamics.

Unsafe

unsafeDynamic :: Reflex t => Behavior t a -> Event t a -> Dynamic t a

Construct a Dynamic from a Behavior and an Event. The Behavior must change when and only when the Event fires, such that the Behavior's value is always equal to the most recent firing of the Event; if this is not the case, the resulting Dynamic will behave nondeterministically.