Control.Monad.Ref

Documentation

class Monad m => MonadRef m 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.

Minimal complete definition

newRef, readRef, writeRef

Associated Types

type Ref m :: * -> *

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

Instances

MonadRef IO

Associated Types

type Ref (IO :: * -> *) :: * -> *

Methods

newRef :: a -> IO (Ref IO a)

readRef :: Ref IO a -> IO a

writeRef :: Ref IO a -> a -> IO ()

modifyRef :: Ref IO a -> (a -> a) -> IO ()

modifyRef' :: Ref IO a -> (a -> a) -> IO ()

MonadRef STM

Associated Types

type Ref (STM :: * -> *) :: * -> *

Methods

newRef :: a -> STM (Ref STM a)

readRef :: Ref STM a -> STM a

writeRef :: Ref STM a -> a -> STM ()

modifyRef :: Ref STM a -> (a -> a) -> STM ()

modifyRef' :: Ref STM a -> (a -> a) -> STM ()

MonadRef (ST s)

Associated Types

type Ref (ST s :: * -> *) :: * -> *

Methods

newRef :: a -> ST s (Ref (ST s) a)

readRef :: Ref (ST s) a -> ST s a

writeRef :: Ref (ST s) a -> a -> ST s ()

modifyRef :: Ref (ST s) a -> (a -> a) -> ST s ()

modifyRef' :: Ref (ST s) a -> (a -> a) -> ST s ()

MonadRef m => MonadRef (MaybeT m)

Associated Types

type Ref (MaybeT m :: * -> *) :: * -> *

Methods

newRef :: a -> MaybeT m (Ref (MaybeT m) a)

readRef :: Ref (MaybeT m) a -> MaybeT m a

writeRef :: Ref (MaybeT m) a -> a -> MaybeT m ()

modifyRef :: Ref (MaybeT m) a -> (a -> a) -> MaybeT m ()

modifyRef' :: Ref (MaybeT m) a -> (a -> a) -> MaybeT m ()

MonadRef m => MonadRef (ListT m)

Associated Types

type Ref (ListT m :: * -> *) :: * -> *

Methods

newRef :: a -> ListT m (Ref (ListT m) a)

readRef :: Ref (ListT m) a -> ListT m a

writeRef :: Ref (ListT m) a -> a -> ListT m ()

modifyRef :: Ref (ListT m) a -> (a -> a) -> ListT m ()

modifyRef' :: Ref (ListT m) a -> (a -> a) -> ListT m ()

(Monoid w, MonadRef m) => MonadRef (WriterT w m)

Associated Types

type Ref (WriterT w m :: * -> *) :: * -> *

Methods

newRef :: a -> WriterT w m (Ref (WriterT w m) a)

readRef :: Ref (WriterT w m) a -> WriterT w m a

writeRef :: Ref (WriterT w m) a -> a -> WriterT w m ()

modifyRef :: Ref (WriterT w m) a -> (a -> a) -> WriterT w m ()

modifyRef' :: Ref (WriterT w m) a -> (a -> a) -> WriterT w m ()

(Monoid w, MonadRef m) => MonadRef (WriterT w m)

Associated Types

type Ref (WriterT w m :: * -> *) :: * -> *

Methods

newRef :: a -> WriterT w m (Ref (WriterT w m) a)

readRef :: Ref (WriterT w m) a -> WriterT w m a

writeRef :: Ref (WriterT w m) a -> a -> WriterT w m ()

modifyRef :: Ref (WriterT w m) a -> (a -> a) -> WriterT w m ()

modifyRef' :: Ref (WriterT w m) a -> (a -> a) -> WriterT w m ()

MonadRef m => MonadRef (StateT s m)

Associated Types

type Ref (StateT s m :: * -> *) :: * -> *

Methods

newRef :: a -> StateT s m (Ref (StateT s m) a)

readRef :: Ref (StateT s m) a -> StateT s m a

writeRef :: Ref (StateT s m) a -> a -> StateT s m ()

modifyRef :: Ref (StateT s m) a -> (a -> a) -> StateT s m ()

modifyRef' :: Ref (StateT s m) a -> (a -> a) -> StateT s m ()

MonadRef m => MonadRef (StateT s m)

Associated Types

type Ref (StateT s m :: * -> *) :: * -> *

Methods

newRef :: a -> StateT s m (Ref (StateT s m) a)

readRef :: Ref (StateT s m) a -> StateT s m a

writeRef :: Ref (StateT s m) a -> a -> StateT s m ()

modifyRef :: Ref (StateT s m) a -> (a -> a) -> StateT s m ()

modifyRef' :: Ref (StateT s m) a -> (a -> a) -> StateT s m ()

MonadRef m => MonadRef (IdentityT * m)

Associated Types

type Ref (IdentityT * m :: * -> *) :: * -> *

Methods

newRef :: a -> IdentityT * m (Ref (IdentityT * m) a)

readRef :: Ref (IdentityT * m) a -> IdentityT * m a

writeRef :: Ref (IdentityT * m) a -> a -> IdentityT * m ()

modifyRef :: Ref (IdentityT * m) a -> (a -> a) -> IdentityT * m ()

modifyRef' :: Ref (IdentityT * m) a -> (a -> a) -> IdentityT * m ()

(Error e, MonadRef m) => MonadRef (ErrorT e m)

Associated Types

type Ref (ErrorT e m :: * -> *) :: * -> *

Methods

newRef :: a -> ErrorT e m (Ref (ErrorT e m) a)

readRef :: Ref (ErrorT e m) a -> ErrorT e m a

writeRef :: Ref (ErrorT e m) a -> a -> ErrorT e m ()

modifyRef :: Ref (ErrorT e m) a -> (a -> a) -> ErrorT e m ()

modifyRef' :: Ref (ErrorT e m) a -> (a -> a) -> ErrorT e m ()

MonadRef m => MonadRef (ExceptT e m)

Associated Types

type Ref (ExceptT e m :: * -> *) :: * -> *

Methods

newRef :: a -> ExceptT e m (Ref (ExceptT e m) a)

readRef :: Ref (ExceptT e m) a -> ExceptT e m a

writeRef :: Ref (ExceptT e m) a -> a -> ExceptT e m ()

modifyRef :: Ref (ExceptT e m) a -> (a -> a) -> ExceptT e m ()

modifyRef' :: Ref (ExceptT e m) a -> (a -> a) -> ExceptT e m ()

MonadRef m => MonadRef (ReaderT * r m)

Associated Types

type Ref (ReaderT * r m :: * -> *) :: * -> *

Methods

newRef :: a -> ReaderT * r m (Ref (ReaderT * r m) a)

readRef :: Ref (ReaderT * r m) a -> ReaderT * r m a

writeRef :: Ref (ReaderT * r m) a -> a -> ReaderT * r m ()

modifyRef :: Ref (ReaderT * r m) a -> (a -> a) -> ReaderT * r m ()

modifyRef' :: Ref (ReaderT * r m) a -> (a -> a) -> ReaderT * r m ()

MonadRef m => MonadRef (ContT * r m)

Associated Types

type Ref (ContT * r m :: * -> *) :: * -> *

Methods

newRef :: a -> ContT * r m (Ref (ContT * r m) a)

readRef :: Ref (ContT * r m) a -> ContT * r m a

writeRef :: Ref (ContT * r m) a -> a -> ContT * r m ()

modifyRef :: Ref (ContT * r m) a -> (a -> a) -> ContT * r m ()

modifyRef' :: Ref (ContT * r m) a -> (a -> a) -> ContT * r m ()

class MonadRef m => MonadAtomicRef m where

Minimal complete definition

atomicModifyRef

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.

Instances

MonadAtomicRef IO

Methods

atomicModifyRef :: Ref IO a -> (a -> (a, b)) -> IO b

atomicModifyRef' :: Ref IO a -> (a -> (a, b)) -> IO b

MonadAtomicRef STM

Methods

atomicModifyRef :: Ref STM a -> (a -> (a, b)) -> STM b

atomicModifyRef' :: Ref STM a -> (a -> (a, b)) -> STM b

MonadAtomicRef m => MonadAtomicRef (MaybeT m)

Methods

atomicModifyRef :: Ref (MaybeT m) a -> (a -> (a, b)) -> MaybeT m b

atomicModifyRef' :: Ref (MaybeT m) a -> (a -> (a, b)) -> MaybeT m b

MonadAtomicRef m => MonadAtomicRef (ListT m)

Methods

atomicModifyRef :: Ref (ListT m) a -> (a -> (a, b)) -> ListT m b

atomicModifyRef' :: Ref (ListT m) a -> (a -> (a, b)) -> ListT m b

(Monoid w, MonadAtomicRef m) => MonadAtomicRef (WriterT w m)

Methods

atomicModifyRef :: Ref (WriterT w m) a -> (a -> (a, b)) -> WriterT w m b

atomicModifyRef' :: Ref (WriterT w m) a -> (a -> (a, b)) -> WriterT w m b

(Monoid w, MonadAtomicRef m) => MonadAtomicRef (WriterT w m)

Methods

atomicModifyRef :: Ref (WriterT w m) a -> (a -> (a, b)) -> WriterT w m b

atomicModifyRef' :: Ref (WriterT w m) a -> (a -> (a, b)) -> WriterT w m b

MonadAtomicRef m => MonadAtomicRef (StateT s m)

Methods

atomicModifyRef :: Ref (StateT s m) a -> (a -> (a, b)) -> StateT s m b

atomicModifyRef' :: Ref (StateT s m) a -> (a -> (a, b)) -> StateT s m b

MonadAtomicRef m => MonadAtomicRef (StateT s m)

Methods

atomicModifyRef :: Ref (StateT s m) a -> (a -> (a, b)) -> StateT s m b

atomicModifyRef' :: Ref (StateT s m) a -> (a -> (a, b)) -> StateT s m b

MonadAtomicRef m => MonadAtomicRef (IdentityT * m)

Methods

atomicModifyRef :: Ref (IdentityT * m) a -> (a -> (a, b)) -> IdentityT * m b

atomicModifyRef' :: Ref (IdentityT * m) a -> (a -> (a, b)) -> IdentityT * m b

(Error e, MonadAtomicRef m) => MonadAtomicRef (ErrorT e m)

Methods

atomicModifyRef :: Ref (ErrorT e m) a -> (a -> (a, b)) -> ErrorT e m b

atomicModifyRef' :: Ref (ErrorT e m) a -> (a -> (a, b)) -> ErrorT e m b

MonadAtomicRef m => MonadAtomicRef (ReaderT * r m)

Methods

atomicModifyRef :: Ref (ReaderT * r m) a -> (a -> (a, b)) -> ReaderT * r m b

atomicModifyRef' :: Ref (ReaderT * r m) a -> (a -> (a, b)) -> ReaderT * r m b

MonadAtomicRef m => MonadAtomicRef (ContT * r m)

Methods

atomicModifyRef :: Ref (ContT * r m) a -> (a -> (a, b)) -> ContT * r m b

atomicModifyRef' :: Ref (ContT * r m) a -> (a -> (a, b)) -> ContT * r m b