Reflex.Host.Basic

BasicGuest provides instances that most reflex programs need:

• MonadIO
• MonadFix
• MonadSample
• MonadHold
• NotReady
• PostBuild
• PerformEvent — Performable (BasicGuest t m) has MonadIO
• TriggerEvent
• Adjustable

For some simple usage examples, see the examples directory

Documentation

data BasicGuest t (m :: * -> *) a

Instances

ReflexHost t => NotReady t (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

notReadyUntil :: Event t a -> BasicGuest t m ()

notReady :: BasicGuest t m ()

(Reflex t, ReflexHost t, Ref m ~ Ref IO, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO, MonadIO (HostFrame t), PrimMonad (HostFrame t), MonadIO m) => PerformEvent t (BasicGuest t m)

Defined in Reflex.Host.Basic

Associated Types

type Performable (BasicGuest t m) :: Type -> Type

Methods

performEvent :: Event t (Performable (BasicGuest t m) a) -> BasicGuest t m (Event t a)

performEvent_ :: Event t (Performable (BasicGuest t m) ()) -> BasicGuest t m ()

(Reflex t, ReflexHost t, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO) => TriggerEvent t (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

newTriggerEvent :: BasicGuest t m (Event t a, a -> IO ())

newTriggerEventWithOnComplete :: BasicGuest t m (Event t a, a -> IO () -> IO ())

newEventWithLazyTriggerWithOnComplete :: ((a -> IO () -> IO ()) -> IO (IO ())) -> BasicGuest t m (Event t a)

(Reflex t, ReflexHost t) => PostBuild t (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

getPostBuild :: BasicGuest t m (Event t ())

(Reflex t, ReflexHost t, Ref m ~ Ref IO, MonadHold t m, PrimMonad (HostFrame t)) => Adjustable t (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

runWithReplace :: BasicGuest t m a -> Event t (BasicGuest t m b) -> BasicGuest t m (a, Event t b)

traverseIntMapWithKeyWithAdjust :: (Key -> v -> BasicGuest t m v') -> IntMap v -> Event t (PatchIntMap v) -> BasicGuest t m (IntMap v', Event t (PatchIntMap v'))

traverseDMapWithKeyWithAdjust :: GCompare k => (forall a. k a -> v a -> BasicGuest t m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> BasicGuest t m (DMap k v', Event t (PatchDMap k v'))

traverseDMapWithKeyWithAdjustWithMove :: GCompare k => (forall a. k a -> v a -> BasicGuest t m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> BasicGuest t m (DMap k v', Event t (PatchDMapWithMove k v'))

ReflexHost t => MonadSample (t :: Type) (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

sample :: Behavior t a -> BasicGuest t m a

(ReflexHost t, MonadHold t m) => MonadHold (t :: Type) (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

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

holdDyn :: a -> Event t a -> BasicGuest t m (Dynamic t a)

holdIncremental :: Patch p => PatchTarget p -> Event t p -> BasicGuest t m (Incremental t p)

buildDynamic :: PushM t a -> Event t a -> BasicGuest t m (Dynamic t a)

headE :: Event t a -> BasicGuest t m (Event t a)

ReflexHost t => Monad (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

(>>=) :: BasicGuest t m a -> (a -> BasicGuest t m b) -> BasicGuest t m b

(>>) :: BasicGuest t m a -> BasicGuest t m b -> BasicGuest t m b

return :: a -> BasicGuest t m a

fail :: String -> BasicGuest t m a

ReflexHost t => Functor (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

fmap :: (a -> b) -> BasicGuest t m a -> BasicGuest t m b

(<$) :: a -> BasicGuest t m b -> BasicGuest t m a

ReflexHost t => MonadFix (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

mfix :: (a -> BasicGuest t m a) -> BasicGuest t m a

ReflexHost t => Applicative (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

pure :: a -> BasicGuest t m a

(<*>) :: BasicGuest t m (a -> b) -> BasicGuest t m a -> BasicGuest t m b

liftA2 :: (a -> b -> c) -> BasicGuest t m a -> BasicGuest t m b -> BasicGuest t m c

(*>) :: BasicGuest t m a -> BasicGuest t m b -> BasicGuest t m b

(<*) :: BasicGuest t m a -> BasicGuest t m b -> BasicGuest t m a

(MonadIO m, ReflexHost t, MonadIO (HostFrame t)) => MonadIO (BasicGuest t m)

Defined in Reflex.Host.Basic

Methods

liftIO :: IO a -> BasicGuest t m a

type Performable (BasicGuest t m)

Defined in Reflex.Host.Basic

type Performable (BasicGuest t m) = HostFrame t

type BasicGuestConstraints t (m :: * -> *) = (MonadReflexHost t m, MonadHold t m, MonadSample t m, Ref m ~ Ref IO, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO, MonadIO (HostFrame t), PrimMonad (HostFrame t), MonadIO m, MonadFix m)

basicHostWithQuit :: (forall t m. BasicGuestConstraints t m => BasicGuest t m (a, Event t ())) -> IO a

Run a BasicGuest

The program will exit when the Event returned by the BasicGuest fires

basicHostForever :: (forall t m. BasicGuestConstraints t m => BasicGuest t m a) -> IO a

Run a BasicGuest without a quit Event

repeatUntilQuit

Arguments

:: BasicGuestConstraints t m

=> IO a

Action to repeatedly run

-> Event t ()

Event to stop the action

-> BasicGuest t m ()

Augment a BasicGuest with an action that is repeatedly run until the provided event fires

Example - providing a 'tick' Event to a network

myNetwork :: (Reflex t, MonadHold t m, MonadFix m) => Event t () -> m (Dynamic t Int)
myNetwork eTick = count eTick

myGuest :: BasicGuestConstraints t m => BasicGuest t m ((), Event t ())
myGuest = do
  (eTick, sendTick) <- newTriggerEvent
  dCount <- myNetwork eTick
  let
    eCountUpdated = updated dCount
    eQuit = () <$ ffilter (==5) eCountUpdated
  repeatUntilQuit eQuit (threadDelay 1000000 *> sendTick ())
  performEvent_ $ liftIO . print <$> eCountUpdated
  pure ((), eQuit)

main :: IO ()
main = basicHostWithQuit myGuest