Safe Haskell	None
Language	Haskell2010

Control.Monad.Primitive.Extra

Description

Extra utilities and abstractions for Control.Monad.Primitive.

The API structure is stable, but the naming is not great and may change. Ideally we would push this upstream into Control.Monad.Primitive itself.

Synopsis

newtype PrimST m s = PrimST {
- statePrimST :: forall a. (s -> (a, s)) -> m a
}
readPrimST :: PrimST m s -> m s
writePrimST :: PrimST m s -> s -> m ()
modifyPrimST :: PrimST m s -> (s -> s) -> m ()
stMutVar :: PrimMonad m => MutVar (PrimState m) s -> PrimST m s
class Monad m => PrimMonad (m :: Type -> Type) where
- type PrimState (m :: Type -> Type) :: Type

Documentation

newtype PrimST m s Source #

Type abstracting a mutable reference.

This can be thought of as a mutable version of a Lens' (PrimState m) s with the lens functor specialised to (,) a for each a.

Constructors

PrimST
Fields statePrimST :: forall a. (s -> (a, s)) -> m a

readPrimST :: PrimST m s -> m s Source #

writePrimST :: PrimST m s -> s -> m () Source #

modifyPrimST :: PrimST m s -> (s -> s) -> m () Source #

stMutVar :: PrimMonad m => MutVar (PrimState m) s -> PrimST m s Source #

class Monad m => PrimMonad (m :: Type -> Type) #

Class of monads which can perform primitive state-transformer actions

Minimal complete definition

primitive

Associated Types

type PrimState (m :: Type -> Type) :: Type #

State token type

Instances

PrimMonad IO
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState IO :: Type # Methods primitive :: (State# (PrimState IO) -> (#State# (PrimState IO), a#)) -> IO a #
PrimMonad (ST s)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ST s) :: Type # Methods primitive :: (State# (PrimState (ST s)) -> (#State# (PrimState (ST s)), a#)) -> ST s a #
PrimMonad m => PrimMonad (MaybeT m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (MaybeT m) :: Type # Methods primitive :: (State# (PrimState (MaybeT m)) -> (#State# (PrimState (MaybeT m)), a#)) -> MaybeT m a #
PrimMonad m => PrimMonad (ListT m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ListT m) :: Type # Methods primitive :: (State# (PrimState (ListT m)) -> (#State# (PrimState (ListT m)), a#)) -> ListT m a #
PrimMonad m => PrimMonad (IdentityT m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (IdentityT m) :: Type # Methods primitive :: (State# (PrimState (IdentityT m)) -> (#State# (PrimState (IdentityT m)), a#)) -> IdentityT m a #
PrimMonad m => PrimMonad (ExceptT e m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ExceptT e m) :: Type # Methods primitive :: (State# (PrimState (ExceptT e m)) -> (#State# (PrimState (ExceptT e m)), a#)) -> ExceptT e m a #
(Error e, PrimMonad m) => PrimMonad (ErrorT e m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ErrorT e m) :: Type # Methods primitive :: (State# (PrimState (ErrorT e m)) -> (#State# (PrimState (ErrorT e m)), a#)) -> ErrorT e m a #
PrimMonad m => PrimMonad (StateT s m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (StateT s m) :: Type # Methods primitive :: (State# (PrimState (StateT s m)) -> (#State# (PrimState (StateT s m)), a#)) -> StateT s m a #
PrimMonad m => PrimMonad (StateT s m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (StateT s m) :: Type # Methods primitive :: (State# (PrimState (StateT s m)) -> (#State# (PrimState (StateT s m)), a#)) -> StateT s m a #
(Monoid w, PrimMonad m) => PrimMonad (WriterT w m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (WriterT w m) :: Type # Methods primitive :: (State# (PrimState (WriterT w m)) -> (#State# (PrimState (WriterT w m)), a#)) -> WriterT w m a #
(Monoid w, PrimMonad m) => PrimMonad (WriterT w m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (WriterT w m) :: Type # Methods primitive :: (State# (PrimState (WriterT w m)) -> (#State# (PrimState (WriterT w m)), a#)) -> WriterT w m a #
(Monoid w, PrimMonad m) => PrimMonad (AccumT w m)	Since: primitive-0.6.3.0
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (AccumT w m) :: Type # Methods primitive :: (State# (PrimState (AccumT w m)) -> (#State# (PrimState (AccumT w m)), a#)) -> AccumT w m a #
PrimMonad m => PrimMonad (SelectT r m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (SelectT r m) :: Type # Methods primitive :: (State# (PrimState (SelectT r m)) -> (#State# (PrimState (SelectT r m)), a#)) -> SelectT r m a #
PrimMonad m => PrimMonad (ContT r m)	Since: primitive-0.6.3.0
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ContT r m) :: Type # Methods primitive :: (State# (PrimState (ContT r m)) -> (#State# (PrimState (ContT r m)), a#)) -> ContT r m a #
PrimMonad m => PrimMonad (ReaderT r m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ReaderT r m) :: Type # Methods primitive :: (State# (PrimState (ReaderT r m)) -> (#State# (PrimState (ReaderT r m)), a#)) -> ReaderT r m a #
(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (RWST r w s m) :: Type # Methods primitive :: (State# (PrimState (RWST r w s m)) -> (#State# (PrimState (RWST r w s m)), a#)) -> RWST r w s m a #
(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (RWST r w s m) :: Type # Methods primitive :: (State# (PrimState (RWST r w s m)) -> (#State# (PrimState (RWST r w s m)), a#)) -> RWST r w s m a #