MonadVar

Documentation

class Monad m => MonadNew m v where

A type class for containers that can be created and initialized with a single value.

Minimal complete definition

new

Methods

new :: a -> m (v a)

Instances

MonadNew IO TVar

Methods

new :: a -> IO (TVar a)

MonadNew IO IORef

Methods

new :: a -> IO (IORef a)

MonadNew IO MVar

Methods

new :: a -> IO (MVar a)

MonadNew IO TMVar

Methods

new :: a -> IO (TMVar a)

MonadNew STM TVar

Methods

new :: a -> STM (TVar a)

MonadNew STM TMVar

Methods

new :: a -> STM (TMVar a)

MonadNew (ST s) (STRef s)

Methods

new :: a -> ST s (STRef s a)

class (MonadRead m v, Monad m) => MonadLock m v where

A type class for at most one element containers. An attempt to get a value from an empty container or to put a value into a full container results in a block. I.e. this is a type class for MVar-like things.

Minimal complete definition

hold, fill, tryHold, tryFill, tryRead, newEmpty, isEmpty

Methods

hold :: v a -> m a

Get a value from a container. Block on empty. A la takeMVar.

fill :: v a -> a -> m ()

Put a value to a container. Block on full. A la putMVar.

tryHold :: v a -> m (Maybe a)

Get a value from a container. Return Nothing on empty. A la tryTakeMVar.

tryFill :: v a -> a -> m Bool

Put a value to a container. Return Nothing on full. A la tryPutMVar.

tryRead :: v a -> m (Maybe a)

Read a value from a container. Return Nothing on empty. A la tryReadMVar.

newEmpty :: m (v a)

Create an empty container. A la newEmptyMVar.

isEmpty :: v a -> m Bool

Check whether a container is empty. A la isEmptyMVar.

Instances

MonadLock IO MVar

Methods

hold :: MVar a -> IO a

fill :: MVar a -> a -> IO ()

tryHold :: MVar a -> IO (Maybe a)

tryFill :: MVar a -> a -> IO Bool

tryRead :: MVar a -> IO (Maybe a)

newEmpty :: IO (MVar a)

isEmpty :: MVar a -> IO Bool

MonadLock IO TMVar

Methods

hold :: TMVar a -> IO a

fill :: TMVar a -> a -> IO ()

tryHold :: TMVar a -> IO (Maybe a)

tryFill :: TMVar a -> a -> IO Bool

tryRead :: TMVar a -> IO (Maybe a)

newEmpty :: IO (TMVar a)

isEmpty :: TMVar a -> IO Bool

MonadLock STM TMVar

Methods

hold :: TMVar a -> STM a

fill :: TMVar a -> a -> STM ()

tryHold :: TMVar a -> STM (Maybe a)

tryFill :: TMVar a -> a -> STM Bool

tryRead :: TMVar a -> STM (Maybe a)

newEmpty :: STM (TMVar a)

isEmpty :: TMVar a -> STM Bool

(MonadTrans t, Monad (t m), MonadLock m v) => MonadLock (t m) v

Methods

hold :: v a -> t m a

fill :: v a -> a -> t m ()

tryHold :: v a -> t m (Maybe a)

tryFill :: v a -> a -> t m Bool

tryRead :: v a -> t m (Maybe a)

newEmpty :: t m (v a)

isEmpty :: v a -> t m Bool

class Monad m => MonadRead m v where

A type class for containers from which a single value can be read.

Minimal complete definition

read

Methods

read :: v a -> m a

Instances

MonadRead IO TVar

Methods

read :: TVar a -> IO a

MonadRead IO IORef

Methods

read :: IORef a -> IO a

MonadRead IO MVar

Methods

read :: MVar a -> IO a

MonadRead IO TMVar

Methods

read :: TMVar a -> IO a

MonadRead STM TVar

Methods

read :: TVar a -> STM a

MonadRead STM TMVar

Methods

read :: TMVar a -> STM a

(MonadTrans t, Monad (t m), MonadRead m v) => MonadRead (t m) v

Methods

read :: v a -> t m a

MonadRead (ST s) (STRef s)

Methods

read :: STRef s a -> ST s a

class Monad m => MonadWrite m v where

A type class for containers to which a single value can be written.

Minimal complete definition

write

Methods

write :: v a -> a -> m ()

Instances

MonadWrite IO TVar

Methods

write :: TVar a -> a -> IO ()

MonadWrite IO IORef

Methods

write :: IORef a -> a -> IO ()

MonadWrite IO MVar

Methods

write :: MVar a -> a -> IO ()

MonadWrite IO TMVar

Methods

write :: TMVar a -> a -> IO ()

MonadWrite STM TVar

Methods

write :: TVar a -> a -> STM ()

MonadWrite STM TMVar

Methods

write :: TMVar a -> a -> STM ()

(MonadTrans t, Monad (t m), MonadWrite m v) => MonadWrite (t m) v

Methods

write :: v a -> a -> t m ()

MonadWrite (ST s) (STRef s)

Methods

write :: STRef s a -> a -> ST s ()

class Monad m => MonadSwap m v where

A type class for containers for which one value can be replaced with an another (not necessarily at the same position).

Minimal complete definition

swap

Methods

swap :: v a -> a -> m a

Replace a value from a container by a new one and return the original value.

Instances

MonadSwap IO TVar

Methods

swap :: TVar a -> a -> IO a

MonadSwap IO IORef

Methods

swap :: IORef a -> a -> IO a

MonadSwap IO MVar

Methods

swap :: MVar a -> a -> IO a

MonadSwap IO TMVar

Methods

swap :: TMVar a -> a -> IO a

MonadSwap STM TVar

Methods

swap :: TVar a -> a -> STM a

MonadSwap STM TMVar

Methods

swap :: TMVar a -> a -> STM a

(MonadTrans t, Monad (t m), MonadSwap m v) => MonadSwap (t m) v

Methods

swap :: v a -> a -> t m a

MonadSwap (ST s) (STRef s)

Methods

swap :: STRef s a -> a -> ST s a

class MonadWrite m v => MonadMutate_ m v where

A type class for mutable containers which can be mapped over.

Minimal complete definition

mutate_

Methods

mutate_ :: v a -> (a -> a) -> m ()

Instances

MonadMutate_ IO TVar

Methods

mutate_ :: TVar a -> (a -> a) -> IO ()

MonadMutate_ IO IORef

Methods

mutate_ :: IORef a -> (a -> a) -> IO ()

MonadMutate_ IO MVar

Methods

mutate_ :: MVar a -> (a -> a) -> IO ()

MonadMutate_ IO TMVar

Methods

mutate_ :: TMVar a -> (a -> a) -> IO ()

MonadMutate_ STM TVar

Methods

mutate_ :: TVar a -> (a -> a) -> STM ()

MonadMutate_ STM TMVar

Methods

mutate_ :: TMVar a -> (a -> a) -> STM ()

(MonadTrans t, Monad (t m), MonadMutate_ m v) => MonadMutate_ (t m) v

Methods

mutate_ :: v a -> (a -> a) -> t m ()

MonadMutate_ (ST s) (STRef s)

Methods

mutate_ :: STRef s a -> (a -> a) -> ST s ()

class (MonadRead m v, MonadMutate_ m v) => MonadMutate m v where

A type class for one-element containers which can be mapped and folded over simultaneously. These are basically variables.

Minimal complete definition

mutate

Methods

mutate :: v a -> (a -> (a, b)) -> m b

Mutate a variable and return an additional value.

Instances

MonadMutate IO TVar

Methods

mutate :: TVar a -> (a -> (a, b)) -> IO b

MonadMutate IO IORef

Methods

mutate :: IORef a -> (a -> (a, b)) -> IO b

MonadMutate IO MVar

Methods

mutate :: MVar a -> (a -> (a, b)) -> IO b

MonadMutate IO TMVar

Methods

mutate :: TMVar a -> (a -> (a, b)) -> IO b

MonadMutate STM TVar

Methods

mutate :: TVar a -> (a -> (a, b)) -> STM b

MonadMutate STM TMVar

Methods

mutate :: TMVar a -> (a -> (a, b)) -> STM b

(MonadTrans t, Monad (t m), MonadMutate m v) => MonadMutate (t m) v

Methods

mutate :: v a -> (a -> (a, b)) -> t m b

MonadMutate (ST s) (STRef s)

Methods

mutate :: STRef s a -> (a -> (a, b)) -> ST s b

class MonadFoldMutate m v where

A type class for mutable containers which can be mapped and folded over simultaneously.

Minimal complete definition

foldMutate

Methods

foldMutate :: Monoid b => v a -> (a -> (a, b)) -> m b

class MonadMutate_ m v => MonadMutateM_ f m v where

A type class for mutable containers which can be monadically mapped over.

Minimal complete definition

mutateM_

Methods

mutateM_ :: v a -> (a -> f a) -> m ()

Instances

MonadMutateM_ IO IO TMVar

Methods

mutateM_ :: TMVar a -> (a -> IO a) -> IO ()

(~) (* -> *) STM stm => MonadMutateM_ stm STM TMVar

Methods

mutateM_ :: TMVar a -> (a -> stm a) -> STM ()

(~) (* -> *) STM stm => MonadMutateM_ stm IO TVar

Methods

mutateM_ :: TVar a -> (a -> stm a) -> IO ()

(~) (* -> *) STM stm => MonadMutateM_ stm STM TVar

Methods

mutateM_ :: TVar a -> (a -> stm a) -> STM ()

(~) (* -> *) IO io => MonadMutateM_ io IO MVar

Methods

mutateM_ :: MVar a -> (a -> io a) -> IO ()

(~) (* -> *) IO io => MonadMutateM_ io IO IORef

Methods

mutateM_ :: IORef a -> (a -> io a) -> IO ()

MonadMutateM_ STM IO TMVar

Methods

mutateM_ :: TMVar a -> (a -> STM a) -> IO ()

(~) (* -> *) (ST s) st_s => MonadMutateM_ st_s (ST s) (STRef s)

Methods

mutateM_ :: STRef s a -> (a -> st_s a) -> ST s ()

class (MonadMutate m v, MonadMutateM_ f m v) => MonadMutateM f m v where

A type class for one-element containers which can be monadically mapped and folded over simultaneously. These are basically variables.

Minimal complete definition

mutateM

Methods

mutateM :: v a -> (a -> f (a, b)) -> m b

Monadically mutate a variable and return an additional value.

Instances

MonadMutateM IO IO TMVar

Methods

mutateM :: TMVar a -> (a -> IO (a, b)) -> IO b

(~) (* -> *) STM stm => MonadMutateM stm STM TMVar

Methods

mutateM :: TMVar a -> (a -> stm (a, b)) -> STM b

(~) (* -> *) STM stm => MonadMutateM stm IO TVar

Methods

mutateM :: TVar a -> (a -> stm (a, b)) -> IO b

(~) (* -> *) STM stm => MonadMutateM stm STM TVar

Methods

mutateM :: TVar a -> (a -> stm (a, b)) -> STM b

(~) (* -> *) IO io => MonadMutateM io IO MVar

Methods

mutateM :: MVar a -> (a -> io (a, b)) -> IO b

(~) (* -> *) IO io => MonadMutateM io IO IORef

Methods

mutateM :: IORef a -> (a -> io (a, b)) -> IO b

MonadMutateM STM IO TMVar

Methods

mutateM :: TMVar a -> (a -> STM (a, b)) -> IO b

(~) (* -> *) (ST s) st_s => MonadMutateM st_s (ST s) (STRef s)

Methods

mutateM :: STRef s a -> (a -> st_s (a, b)) -> ST s b

class MonadFoldMutateM m n v where

A type class for mutable containers which can be monadically mapped and folded over simultaneously.

Minimal complete definition

foldMutateM

Methods

foldMutateM :: Monoid b => v a -> (a -> m (a, b)) -> n b

defaultLockUnsafeWrite :: MonadLock m v => v a -> a -> m ()

Default exception-unsafe write for MonadLock entities.

defaultReadWriteSwap :: (MonadRead m v, MonadWrite m v) => v a -> a -> m a

Default swap for MonadRead and MonadWrite entities.

defaultLockUnsafeSwap :: MonadLock m v => v a -> a -> m a

Default exception-unsafe swap for MonadLock entities.

defaultReadWriteMutate_ :: (MonadRead m v, MonadWrite m v) => v a -> (a -> a) -> m ()

Default mutate_ for MonadRead and MonadWrite entities.

defaultReadWriteMutate :: (MonadRead m v, MonadWrite m v) => v a -> (a -> (a, b)) -> m b

Default mutate for MonadRead and MonadWrite entities.

defaultReadWriteMutateM_ :: (MonadRead m v, MonadWrite m v) => v a -> (a -> m a) -> m ()

Default mutateM_ for MonadRead and MonadWrite entities.

defaultReadWriteMutateM :: (MonadRead m v, MonadWrite m v) => v a -> (a -> m (a, b)) -> m b

Default mutateM for MonadRead and MonadWrite entities.

defaultLockUnsafeMutate_ :: MonadLock m v => v a -> (a -> a) -> m ()

Default exception-unsafe mutate_ for MonadLock entities.

defaultLockUnsafeMutate :: MonadLock m v => v a -> (a -> (a, b)) -> m b

Default exception-unsafe mutate for MonadLock entities.

defaultLockUnsafeMutateM_ :: MonadLock m v => v a -> (a -> m a) -> m ()

Default exception-unsafe mutateM_ for MonadLock entities.

defaultLockUnsafeMutateM :: MonadLock m v => v a -> (a -> m (a, b)) -> m b

Default exception-unsafe mutateM for MonadLock entities.

defaultLockIOMutateM_ :: MonadLock IO v => v a -> (a -> IO a) -> IO ()

Default mutateM_ for MonadLock IO entities

defaultLockIOMutateM :: MonadLock IO v => v a -> (a -> IO (a, b)) -> IO b

Default mutateM for MonadLock IO entities.

postMutate_ :: MonadMutate m v => v a -> (a -> a) -> m a

Mutate a variable and also return its old value.

preMutate_ :: MonadMutate m v => v a -> (a -> a) -> m a

Mutate a variable and also return its new value.

postMutate :: MonadMutate m v => v a -> (a -> (a, b)) -> m (a, b)

Mutate a variable and also return its old value along with an additional value.

preMutate :: MonadMutate m v => v a -> (a -> (a, b)) -> m (a, b)

Mutate a variable and also return its new value along with an additional value.

postMutateM_ :: (MonadMutateM f m v, Functor f) => v a -> (a -> f a) -> m a

Monadically mutate a variable and also return its old value.

preMutateM_ :: (MonadMutateM f m v, Functor f) => v a -> (a -> f a) -> m a

Monadically mutate a variable and also return its new value.

postMutateM :: (MonadMutateM f m v, Functor f) => v a -> (a -> f (a, b)) -> m (a, b)

Monadically mutate a variable and also return its old value along with an additional value.

preMutateM :: (MonadMutateM f m v, Functor f) => v a -> (a -> f (a, b)) -> m (a, b)

Monadically mutate a variable and also return its new value along with an additional value.