SafeBuffer

SafeBufferMonad

class Monad m => SafeBufferMonad s m | m -> s where

Minimal complete definition

readBuffer, writeBuffer, clearBuffer, modifyBuffer

Methods

readBuffer :: m s

Retrieves the buffer's current content.

writeBuffer :: s -> m ()

Appends a message to the buffer.

clearBuffer :: m s

Retrieves the buffer's current content before clearing it.

modifyBuffer :: (s -> s) -> m ()

Applies a given function to the buffer's content.

Instances

(MonadIO m, Monoid s) => SafeBufferMonad s (SafeBufferConcurrentT s m)

Methods

readBuffer :: SafeBufferConcurrentT s m s

writeBuffer :: s -> SafeBufferConcurrentT s m ()

clearBuffer :: SafeBufferConcurrentT s m s

modifyBuffer :: (s -> s) -> SafeBufferConcurrentT s m ()

(MonadIO m, Monoid s) => SafeBufferMonad s (SafeBufferT s m)

Methods

readBuffer :: SafeBufferT s m s

writeBuffer :: s -> SafeBufferT s m ()

clearBuffer :: SafeBufferT s m s

modifyBuffer :: (s -> s) -> SafeBufferT s m ()

SafeBufferT

newtype SafeBufferT s m a

Constructors

SafeBufferT

Fields

• runBufferT :: ReaderT (IORef s) m a

Instances

MonadWriter r m => MonadWriter r (SafeBufferT s m)

Methods

writer :: (a, r) -> SafeBufferT s m a

tell :: r -> SafeBufferT s m ()

listen :: SafeBufferT s m a -> SafeBufferT s m (a, r)

pass :: SafeBufferT s m (a, r -> r) -> SafeBufferT s m a

MonadState s m => MonadState s (SafeBufferT s m)

Methods

get :: SafeBufferT s m s

put :: s -> SafeBufferT s m ()

state :: (s -> (a, s)) -> SafeBufferT s m a

MonadError e m => MonadError e (SafeBufferT s m)

Methods

throwError :: e -> SafeBufferT s m a

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

(MonadIO m, Monoid s) => SafeBufferMonad s (SafeBufferT s m)

Methods

readBuffer :: SafeBufferT s m s

writeBuffer :: s -> SafeBufferT s m ()

clearBuffer :: SafeBufferT s m s

modifyBuffer :: (s -> s) -> SafeBufferT s m ()

MonadTrans (SafeBufferT s)

Methods

lift :: Monad m => m a -> SafeBufferT s m a

Monad m => MonadReader (IORef s) (SafeBufferT s m)

Methods

ask :: SafeBufferT s m (IORef s)

local :: (IORef s -> IORef s) -> SafeBufferT s m a -> SafeBufferT s m a

reader :: (IORef s -> a) -> SafeBufferT s m a

Monad m => Monad (SafeBufferT s m)

Methods

(>>=) :: SafeBufferT s m a -> (a -> SafeBufferT s m b) -> SafeBufferT s m b

(>>) :: SafeBufferT s m a -> SafeBufferT s m b -> SafeBufferT s m b

return :: a -> SafeBufferT s m a

fail :: String -> SafeBufferT s m a

Functor m => Functor (SafeBufferT s m)

Methods

fmap :: (a -> b) -> SafeBufferT s m a -> SafeBufferT s m b

(<$) :: a -> SafeBufferT s m b -> SafeBufferT s m a

MonadFix m => MonadFix (SafeBufferT s m)

Methods

mfix :: (a -> SafeBufferT s m a) -> SafeBufferT s m a

MonadFail m => MonadFail (SafeBufferT s m)

Methods

fail :: String -> SafeBufferT s m a

Applicative m => Applicative (SafeBufferT s m)

Methods

pure :: a -> SafeBufferT s m a

(<*>) :: SafeBufferT s m (a -> b) -> SafeBufferT s m a -> SafeBufferT s m b

liftA2 :: (a -> b -> c) -> SafeBufferT s m a -> SafeBufferT s m b -> SafeBufferT s m c

(*>) :: SafeBufferT s m a -> SafeBufferT s m b -> SafeBufferT s m b

(<*) :: SafeBufferT s m a -> SafeBufferT s m b -> SafeBufferT s m a

MonadZip m => MonadZip (SafeBufferT s m)

Methods

mzip :: SafeBufferT s m a -> SafeBufferT s m b -> SafeBufferT s m (a, b)

mzipWith :: (a -> b -> c) -> SafeBufferT s m a -> SafeBufferT s m b -> SafeBufferT s m c

munzip :: SafeBufferT s m (a, b) -> (SafeBufferT s m a, SafeBufferT s m b)

MonadIO m => MonadIO (SafeBufferT s m)

Methods

liftIO :: IO a -> SafeBufferT s m a

Alternative m => Alternative (SafeBufferT s m)

Methods

empty :: SafeBufferT s m a

(<|>) :: SafeBufferT s m a -> SafeBufferT s m a -> SafeBufferT s m a

some :: SafeBufferT s m a -> SafeBufferT s m [a]

many :: SafeBufferT s m a -> SafeBufferT s m [a]

MonadPlus m => MonadPlus (SafeBufferT s m)

Methods

mzero :: SafeBufferT s m a

mplus :: SafeBufferT s m a -> SafeBufferT s m a -> SafeBufferT s m a

MonadThrow m => MonadThrow (SafeBufferT s m)

Methods

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

MonadCatch m => MonadCatch (SafeBufferT s m)

Methods

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

MonadMask m => MonadMask (SafeBufferT s m)

Methods

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

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

generalBracket :: SafeBufferT s m a -> (a -> ExitCase b -> SafeBufferT s m c) -> (a -> SafeBufferT s m b) -> SafeBufferT s m (b, c)

MonadCont m => MonadCont (SafeBufferT s m)

Methods

callCC :: ((a -> SafeBufferT s m b) -> SafeBufferT s m a) -> SafeBufferT s m a

runBuffer :: forall s m a b. (MonadIO m, MonadMask m, Monoid s) => (s -> m b) -> SafeBufferT s m a -> m a

Runs a buffer and applies a given function to it. If any exception occurs while running the buffer, the function still runs before the exception is rethrown.

tryRunBuffer :: forall e s m a. (MonadIO m, MonadCatch m, Monoid s, Exception e) => SafeBufferT s m a -> m (s, Either e a)

Runs a buffer and returns it, along with either an exception or the computation's result.

It purposefully does NOT catch async exceptions. To understand why, see Asynchronous exception handling in Haskell.

execBuffer :: forall e s m a. (MonadIO m, MonadCatch m, Monoid s, Exception e) => SafeBufferT s m a -> m s

Runs a buffer and swallow exceptions of type e.

It purposefully does NOT catch async exceptions. To understand why, see Asynchronous exception handling in Haskell.

SafeBufferConcurrentT

newtype SafeBufferConcurrentT s m a

Constructors

SafeBufferConcurrentT

Fields

• runBufferConcurrentT :: ReaderT (TVar s) m a

Instances

MonadWriter r m => MonadWriter r (SafeBufferConcurrentT s m)

Methods

writer :: (a, r) -> SafeBufferConcurrentT s m a

tell :: r -> SafeBufferConcurrentT s m ()

listen :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m (a, r)

pass :: SafeBufferConcurrentT s m (a, r -> r) -> SafeBufferConcurrentT s m a

MonadState s m => MonadState s (SafeBufferConcurrentT s m)

Methods

get :: SafeBufferConcurrentT s m s

put :: s -> SafeBufferConcurrentT s m ()

state :: (s -> (a, s)) -> SafeBufferConcurrentT s m a

MonadError e m => MonadError e (SafeBufferConcurrentT s m)

Methods

throwError :: e -> SafeBufferConcurrentT s m a

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

(MonadIO m, Monoid s) => SafeBufferMonad s (SafeBufferConcurrentT s m)

Methods

readBuffer :: SafeBufferConcurrentT s m s

writeBuffer :: s -> SafeBufferConcurrentT s m ()

clearBuffer :: SafeBufferConcurrentT s m s

modifyBuffer :: (s -> s) -> SafeBufferConcurrentT s m ()

MonadTrans (SafeBufferConcurrentT s)

Methods

lift :: Monad m => m a -> SafeBufferConcurrentT s m a

Monad m => MonadReader (TVar s) (SafeBufferConcurrentT s m)

Methods

ask :: SafeBufferConcurrentT s m (TVar s)

local :: (TVar s -> TVar s) -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m a

reader :: (TVar s -> a) -> SafeBufferConcurrentT s m a

Monad m => Monad (SafeBufferConcurrentT s m)

Methods

(>>=) :: SafeBufferConcurrentT s m a -> (a -> SafeBufferConcurrentT s m b) -> SafeBufferConcurrentT s m b

(>>) :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m b

return :: a -> SafeBufferConcurrentT s m a

fail :: String -> SafeBufferConcurrentT s m a

Functor m => Functor (SafeBufferConcurrentT s m)

Methods

fmap :: (a -> b) -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b

(<$) :: a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m a

MonadFix m => MonadFix (SafeBufferConcurrentT s m)

Methods

mfix :: (a -> SafeBufferConcurrentT s m a) -> SafeBufferConcurrentT s m a

MonadFail m => MonadFail (SafeBufferConcurrentT s m)

Methods

fail :: String -> SafeBufferConcurrentT s m a

Applicative m => Applicative (SafeBufferConcurrentT s m)

Methods

pure :: a -> SafeBufferConcurrentT s m a

(<*>) :: SafeBufferConcurrentT s m (a -> b) -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b

liftA2 :: (a -> b -> c) -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m c

(*>) :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m b

(<*) :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m a

MonadZip m => MonadZip (SafeBufferConcurrentT s m)

Methods

mzip :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m (a, b)

mzipWith :: (a -> b -> c) -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m b -> SafeBufferConcurrentT s m c

munzip :: SafeBufferConcurrentT s m (a, b) -> (SafeBufferConcurrentT s m a, SafeBufferConcurrentT s m b)

MonadIO m => MonadIO (SafeBufferConcurrentT s m)

Methods

liftIO :: IO a -> SafeBufferConcurrentT s m a

Alternative m => Alternative (SafeBufferConcurrentT s m)

Methods

empty :: SafeBufferConcurrentT s m a

(<|>) :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m a

some :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m [a]

many :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m [a]

MonadPlus m => MonadPlus (SafeBufferConcurrentT s m)

Methods

mzero :: SafeBufferConcurrentT s m a

mplus :: SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m a -> SafeBufferConcurrentT s m a

MonadThrow m => MonadThrow (SafeBufferConcurrentT s m)

Methods

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

MonadCatch m => MonadCatch (SafeBufferConcurrentT s m)

Methods

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

MonadMask m => MonadMask (SafeBufferConcurrentT s m)

Methods

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

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

generalBracket :: SafeBufferConcurrentT s m a -> (a -> ExitCase b -> SafeBufferConcurrentT s m c) -> (a -> SafeBufferConcurrentT s m b) -> SafeBufferConcurrentT s m (b, c)

MonadCont m => MonadCont (SafeBufferConcurrentT s m)

Methods

callCC :: ((a -> SafeBufferConcurrentT s m b) -> SafeBufferConcurrentT s m a) -> SafeBufferConcurrentT s m a

runBufferConcurrently :: forall s m a b. (MonadIO m, MonadMask m, Monoid s) => (s -> m b) -> SafeBufferConcurrentT s m a -> m a

Runs a buffer that can be safely shared accross threads and applies a given function to it. If an exception occurs while running the buffer, the function still runs before the exception is rethrown.

tryRunBufferConcurrently :: forall e s m a. (MonadIO m, MonadCatch m, Monoid s, Exception e) => SafeBufferConcurrentT s m a -> m (s, Either e a)

Runs a buffer that can be safely shared accross threads and returns it, along with either an exception or the computation's result.

It purposefully does NOT catch async exceptions. To understand why, see Asynchronous exception handling in Haskell.

execBufferConcurrently :: forall e s m a. (MonadIO m, MonadCatch m, Monoid s, Exception e) => SafeBufferConcurrentT s m a -> m s

Runs a buffer that can be safely shared accross threads, and swallows exceptions of type e.

It purposefully does NOT catch async exceptions. To understand why, see Asynchronous exception handling in Haskell.