gore-and-ash-async-1.1.1.0: Core module for Gore&Ash engine that embeds async IO actions into game loop.

Copyright(c) Anton Gushcha, 2016
LicenseBSD3
Maintainerncrashed@gmail.com
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Game.GoreAndAsh.Async.Module

Contents

Description

 

Synopsis

Documentation

newtype AsyncT s m a Source #

Monad transformer of async core module.

s
- State of next core module in modules chain;
m
- Next monad in modules monad stack;
a
- Type of result value;

How to embed module:

type AppStack = ModuleStack [AsyncT, ... other modules ... ] IO

newtype AppMonad a = AppMonad (AppStack a)
  deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadThrow, MonadCatch, MonadAsync)

The module is NOT pure within first phase (see ModuleStack docs), therefore currently only IO end monad can handler the module.

Constructors

AsyncT 

Fields

Instances

MonadBase IO m => MonadBase IO (AsyncT s m) Source # 

Methods

liftBase :: IO α -> AsyncT s m α

MonadError e m => MonadError e (AsyncT s m) Source # 

Methods

throwError :: e -> AsyncT s m a

catchError :: AsyncT s m a -> (e -> AsyncT s m a) -> AsyncT s m a

MonadTrans (AsyncT s) Source # 

Methods

lift :: Monad m => m a -> AsyncT s m a #

Monad m => MonadState (AsyncState s) (AsyncT s m) Source # 

Methods

get :: AsyncT s m (AsyncState s)

put :: AsyncState s -> AsyncT s m ()

state :: (AsyncState s -> (a, AsyncState s)) -> AsyncT s m a

Monad m => Monad (AsyncT s m) Source # 

Methods

(>>=) :: AsyncT s m a -> (a -> AsyncT s m b) -> AsyncT s m b #

(>>) :: AsyncT s m a -> AsyncT s m b -> AsyncT s m b #

return :: a -> AsyncT s m a #

fail :: String -> AsyncT s m a #

Functor m => Functor (AsyncT s m) Source # 

Methods

fmap :: (a -> b) -> AsyncT s m a -> AsyncT s m b #

(<$) :: a -> AsyncT s m b -> AsyncT s m a #

MonadFix m => MonadFix (AsyncT s m) Source # 

Methods

mfix :: (a -> AsyncT s m a) -> AsyncT s m a #

Monad m => Applicative (AsyncT s m) Source # 

Methods

pure :: a -> AsyncT s m a #

(<*>) :: AsyncT s m (a -> b) -> AsyncT s m a -> AsyncT s m b #

(*>) :: AsyncT s m a -> AsyncT s m b -> AsyncT s m b #

(<*) :: AsyncT s m a -> AsyncT s m b -> AsyncT s m a #

MonadIO m => MonadIO (AsyncT s m) Source # 

Methods

liftIO :: IO a -> AsyncT s m a #

MonadThrow m => MonadThrow (AsyncT s m) Source # 

Methods

throwM :: Exception e => e -> AsyncT s m a

MonadMask m => MonadMask (AsyncT s m) Source # 

Methods

mask :: ((forall a. AsyncT s m a -> AsyncT s m a) -> AsyncT s m b) -> AsyncT s m b

uninterruptibleMask :: ((forall a. AsyncT s m a -> AsyncT s m a) -> AsyncT s m b) -> AsyncT s m b

MonadCatch m => MonadCatch (AsyncT s m) Source # 

Methods

catch :: Exception e => AsyncT s m a -> (e -> AsyncT s m a) -> AsyncT s m a

MonadResource m => MonadResource (AsyncT s m) Source # 

Methods

liftResourceT :: ResourceT IO a -> AsyncT s m a

(MonadIO m, MonadThrow m) => MonadAsync (AsyncT s m) Source # 
type ModuleState (AsyncT s m) Source # 
type ModuleState (AsyncT s m) = AsyncState s

Orphan instances

GameModule m s => GameModule (AsyncT s m) (AsyncState s) Source # 

Associated Types

type ModuleState (AsyncT s m :: * -> *) :: *

Methods

runModule :: MonadIO m' => AsyncT s m a -> AsyncState s -> m' (a, AsyncState s)

newModuleState :: MonadIO m' => m' (AsyncState s)

withModule :: Proxy (* -> *) (AsyncT s m) -> IO a -> IO a

cleanupModule :: AsyncState s -> IO ()