Moduleref-tf-0.5.0.1Haskell2010

Control.Monad.Ref

Synopsis

class MonadRef
class MonadAtomicRef

Packageref-tf-0.5.0.1
Exports2
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRef.hs

classclass Monad m => MonadRef (m :: Type -> Type) where

The MonadRef type class abstracts over the details of manipulating references, allowing one to write code that uses references and can operate in any monad that supports reference operations.

Associated types

type family Ref (m :: Type -> Type) :: Type -> Type

Methods

newRef :: a -> m (Ref m a)
Create a new reference
readRef :: Ref m a -> m a
Read the value of a reference
writeRef :: Ref m a -> a -> m ()
Write a new value to a reference
modifyRef :: Ref m a -> (a -> a) -> m ()
Mutate the contents of a reference
modifyRef' :: Ref m a -> (a -> a) -> m ()
Strict version of modifyRef

Instances12MonadRef, …

MonadRef STMDefined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef IODefined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef (ST s)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (MaybeT m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (ExceptT e m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (IdentityT m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (ReaderT r m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (StateT s m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (StateT s m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
(Monoid w, MonadRef m) => MonadRef (WriterT w m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
(Monoid w, MonadRef m) => MonadRef (WriterT w m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadRef m => MonadRef (ContT r m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref

classclass MonadRef m => MonadAtomicRef (m :: Type -> Type) where

Methods

atomicModifyRef :: Ref m a -> (a -> (a, b)) -> m b
Atomically mutate the contents of a reference
atomicModifyRef' :: Ref m a -> (a -> (a, b)) -> m b
Strict version of atomicModifyRef. This forces both the value stored in the reference as well as the value returned.

Instances11MonadAtomicRef, …

MonadAtomicRef STMDefined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef IODefined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef (ST s)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef m => MonadAtomicRef (MaybeT m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef m => MonadAtomicRef (IdentityT m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef m => MonadAtomicRef (ReaderT r m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef m => MonadAtomicRef (StateT s m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef m => MonadAtomicRef (StateT s m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
(Monoid w, MonadAtomicRef m) => MonadAtomicRef (WriterT w m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
(Monoid w, MonadAtomicRef m) => MonadAtomicRef (WriterT w m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref
MonadAtomicRef m => MonadAtomicRef (ContT r m)Defined in ref-tf-0.5.0.1 · Control.Monad.Ref