Control.Monad.Finish

Short-circuiting monad transformer and the corresponding generalizing monad type class.

Documentation

class Monad μ => MonadFinish f μ | μ -> f where

Class of monads that support short-circuiting.

Methods

finish :: f -> μ α

Short-circuit the computation with the provided value.

    finish f >>= rest = finish f

Instances

MonadFinish f μ => MonadFinish f (ListT μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> ListT μ α

MonadFinish f μ => MonadFinish f (MaybeT μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> MaybeT μ α

(MonadFinish f μ, Error e) => MonadFinish f (ErrorT e μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> ErrorT e μ α

MonadFinish f μ => MonadFinish f (ExceptT e μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> ExceptT e μ α

MonadFinish f μ => MonadFinish f (IdentityT μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> IdentityT μ α

MonadFinish f μ => MonadFinish f (ReaderT r μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> ReaderT r μ α

MonadFinish f μ => MonadFinish f (StateT s μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> StateT s μ α

MonadFinish f μ => MonadFinish f (StateT s μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> StateT s μ α

(MonadFinish f μ, Monoid w) => MonadFinish f (WriterT w μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> WriterT w μ α

(MonadFinish f μ, Monoid w) => MonadFinish f (WriterT w μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> WriterT w μ α

MonadFinish f μ => MonadFinish f (AbortT e μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> AbortT e μ α

Monad μ => MonadFinish f (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> FinishT f μ α

MonadFinish f μ => MonadFinish f (ContT r μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> ContT r μ α

(MonadFinish f μ, Monoid w) => MonadFinish f (RWST r w s μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> RWST r w s μ α

(MonadFinish f μ, Monoid w) => MonadFinish f (RWST r w s μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> RWST r w s μ α

type Finish f α = FinishT f Identity α

An alias for FinishT over Identity.

runFinish :: Finish f α -> Either f α

runFinishT specialized for Finish.

runFinish' :: Finish α α -> α

runFinishT' specialized for Finish.

newtype FinishT f (μ :: Type -> Type) α

A monad transformer that extends monad μ with the ability to short-circuit computations with a value of type f.

  runFinishT $ do someStuff
                  when condition $ finish reason
                  otherwiseContinue

Constructors

FinishT

Fields

• runFinishT :: μ (Either f α)

Instances

MonadRWS r w s μ => MonadRWS r w s (FinishT f μ)

Defined in Control.Monad.Finish.Class

MonadAbort e μ => MonadAbort e (FinishT f μ)

Defined in Control.Monad.Abort.Class

Methods

abort :: e -> FinishT f μ α

MonadRecover e μ => MonadRecover e (FinishT f μ)

Defined in Control.Monad.Abort.Class

Methods

recover :: FinishT f μ α -> (e -> FinishT f μ α) -> FinishT f μ α

evaluate :: FinishT f μ α -> FinishT f μ (Either e α)

Monad μ => MonadFinish f (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

finish :: f -> FinishT f μ α

MonadBaseControl η μ => MonadBaseControl η (FinishT e μ)

Defined in Control.Monad.Trans.Finish

Associated Types

type StM (FinishT e μ) a

Methods

liftBaseWith :: (RunInBase (FinishT e μ) η -> η a) -> FinishT e μ a

restoreM :: StM (FinishT e μ) a -> FinishT e μ a

MonadError e μ => MonadError e (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

throwError :: e -> FinishT f μ a

catchError :: FinishT f μ a -> (e -> FinishT f μ a) -> FinishT f μ a

MonadReader r μ => MonadReader r (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

ask :: FinishT f μ r

local :: (r -> r) -> FinishT f μ a -> FinishT f μ a

reader :: (r -> a) -> FinishT f μ a

MonadState s μ => MonadState s (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

get :: FinishT f μ s

put :: s -> FinishT f μ ()

state :: (s -> (a, s)) -> FinishT f μ a

MonadWriter w μ => MonadWriter w (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

writer :: (a, w) -> FinishT f μ a

tell :: w -> FinishT f μ ()

listen :: FinishT f μ a -> FinishT f μ (a, w)

pass :: FinishT f μ (a, w -> w) -> FinishT f μ a

MonadBase η μ => MonadBase η (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

liftBase :: η α -> FinishT f μ α

MonadTransControl (FinishT f)

Defined in Control.Monad.Trans.Finish

Associated Types

type StT (FinishT f) a

Methods

liftWith :: Monad m => (Run (FinishT f) -> m a) -> FinishT f m a

restoreT :: Monad m => m (StT (FinishT f) a) -> FinishT f m a

BindTrans (FinishT f)

Defined in Control.Monad.Trans.Finish

Methods

liftB :: Bind b => b a -> FinishT f b a

MonadTrans (FinishT f)

Defined in Control.Monad.Trans.Finish

Methods

lift :: Monad m => m a -> FinishT f m a

MonadFail μ => MonadFail (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

fail :: String -> FinishT f μ a

MonadFix μ => MonadFix (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

mfix :: (a -> FinishT f μ a) -> FinishT f μ a

MonadIO μ => MonadIO (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

liftIO :: IO a -> FinishT f μ a

MonadZip μ => MonadZip (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

mzip :: FinishT f μ a -> FinishT f μ b -> FinishT f μ (a, b)

mzipWith :: (a -> b -> c) -> FinishT f μ a -> FinishT f μ b -> FinishT f μ c

munzip :: FinishT f μ (a, b) -> (FinishT f μ a, FinishT f μ b)

(Eq f, Eq1 μ) => Eq1 (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

liftEq :: (a -> b -> Bool) -> FinishT f μ a -> FinishT f μ b -> Bool

(Ord f, Ord1 μ) => Ord1 (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

liftCompare :: (a -> b -> Ordering) -> FinishT f μ a -> FinishT f μ b -> Ordering

(Read f, Read1 μ) => Read1 (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (FinishT f μ a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [FinishT f μ a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (FinishT f μ a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [FinishT f μ a]

(Show f, Show1 μ) => Show1 (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> FinishT f μ a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [FinishT f μ a] -> ShowS

(Functor μ, Monad μ) => Applicative (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

pure :: a -> FinishT f μ a

(<*>) :: FinishT f μ (a -> b) -> FinishT f μ a -> FinishT f μ b

liftA2 :: (a -> b -> c) -> FinishT f μ a -> FinishT f μ b -> FinishT f μ c

(*>) :: FinishT f μ a -> FinishT f μ b -> FinishT f μ b

(<*) :: FinishT f μ a -> FinishT f μ b -> FinishT f μ a

Functor μ => Functor (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

fmap :: (a -> b) -> FinishT f μ a -> FinishT f μ b

(<$) :: a -> FinishT f μ b -> FinishT f μ a

Monad μ => Monad (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

(>>=) :: FinishT f μ a -> (a -> FinishT f μ b) -> FinishT f μ b

(>>) :: FinishT f μ a -> FinishT f μ b -> FinishT f μ b

return :: a -> FinishT f μ a

MonadCont μ => MonadCont (FinishT f μ)

Defined in Control.Monad.Finish.Class

Methods

callCC :: ((a -> FinishT f μ b) -> FinishT f μ a) -> FinishT f μ a

Pointed μ => Pointed (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

point :: a -> FinishT f μ a

(Functor μ, Monad μ) => Apply (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

(<.>) :: FinishT f μ (a -> b) -> FinishT f μ a -> FinishT f μ b

(.>) :: FinishT f μ a -> FinishT f μ b -> FinishT f μ b

(<.) :: FinishT f μ a -> FinishT f μ b -> FinishT f μ a

liftF2 :: (a -> b -> c) -> FinishT f μ a -> FinishT f μ b -> FinishT f μ c

(Functor μ, Monad μ) => Bind (FinishT f μ)

Defined in Control.Monad.Trans.Finish

Methods

(>>-) :: FinishT f μ a -> (a -> FinishT f μ b) -> FinishT f μ b

join :: FinishT f μ (FinishT f μ a) -> FinishT f μ a

(Read f, Read1 μ, Read α) => Read (FinishT f μ α)

Defined in Control.Monad.Trans.Finish

Methods

readsPrec :: Int -> ReadS (FinishT f μ α)

readList :: ReadS [FinishT f μ α]

readPrec :: ReadPrec (FinishT f μ α)

readListPrec :: ReadPrec [FinishT f μ α]

(Show f, Show1 μ, Show α) => Show (FinishT f μ α)

Defined in Control.Monad.Trans.Finish

Methods

showsPrec :: Int -> FinishT f μ α -> ShowS

show :: FinishT f μ α -> String

showList :: [FinishT f μ α] -> ShowS

(Eq f, Eq1 μ, Eq α) => Eq (FinishT f μ α)

Defined in Control.Monad.Trans.Finish

Methods

(==) :: FinishT f μ α -> FinishT f μ α -> Bool

(/=) :: FinishT f μ α -> FinishT f μ α -> Bool

(Ord f, Ord1 μ, Ord α) => Ord (FinishT f μ α)

Defined in Control.Monad.Trans.Finish

Methods

compare :: FinishT f μ α -> FinishT f μ α -> Ordering

(<) :: FinishT f μ α -> FinishT f μ α -> Bool

(<=) :: FinishT f μ α -> FinishT f μ α -> Bool

(>) :: FinishT f μ α -> FinishT f μ α -> Bool

(>=) :: FinishT f μ α -> FinishT f μ α -> Bool

max :: FinishT f μ α -> FinishT f μ α -> FinishT f μ α

min :: FinishT f μ α -> FinishT f μ α -> FinishT f μ α

type StT (FinishT f) α

Defined in Control.Monad.Trans.Finish

type StT (FinishT f) α = Either f α

type StM (FinishT e μ) α

Defined in Control.Monad.Trans.Finish

type StM (FinishT e μ) α = ComposeSt (FinishT e) μ α

runFinishT' :: Monad μ => FinishT α μ α -> μ α

A version of runFinishT for the cases where you don't need to distinguish between short-circuits and regular computation results.

module Control.Monad

module Control.Monad.Fix

module Control.Monad.Trans