Safe Haskell	None

Quipper.Utils.Template.ErrorMsgQ

Description

This module provides a simple monad to encapsulate error messages within the Q monad.

Synopsis

Documentation

Shortcut for 'Either String a'.

Type for the monad encapsulating error messages.

Constructors

Instances

Monad ErrMsgQ #
Instance details Defined in Quipper.Utils.Template.ErrorMsgQ Methods (>>=) :: ErrMsgQ a -> (a -> ErrMsgQ b) -> ErrMsgQ b # (>>) :: ErrMsgQ a -> ErrMsgQ b -> ErrMsgQ b # return :: a -> ErrMsgQ a # fail :: String -> ErrMsgQ a #
Functor ErrMsgQ #
Instance details Defined in Quipper.Utils.Template.ErrorMsgQ Methods fmap :: (a -> b) -> ErrMsgQ a -> ErrMsgQ b # (<$) :: a -> ErrMsgQ b -> ErrMsgQ a #
Applicative ErrMsgQ #
Instance details Defined in Quipper.Utils.Template.ErrorMsgQ Methods pure :: a -> ErrMsgQ a # (<>) :: ErrMsgQ (a -> b) -> ErrMsgQ a -> ErrMsgQ b # liftA2 :: (a -> b -> c) -> ErrMsgQ a -> ErrMsgQ b -> ErrMsgQ c # (>) :: ErrMsgQ a -> ErrMsgQ b -> ErrMsgQ b # (<*) :: ErrMsgQ a -> ErrMsgQ b -> ErrMsgQ a #

Set an error message, to be thrown. Usage:

errorMsg "an error happened"

Make a Q computation error-message aware.

Throw the error that has been created, using the given string as a prefix. Usage:

extractQ "name of function: " $ do
  <<commands that may thow an error>>