Copyright	(c) Sergey Vinokurov 2018
License	BSD3-style (see LICENSE)
Maintainer	serg.foo@gmail.com
Safe Haskell	None
Language	Haskell2010

Emacs.Module

Contents

Generic interface
Type synonyms
Types for defining functions
Errors
EmacsM
Reexports
Third-party reexports

Description

Synopsis

class MonadEmacs (m :: k -> Type -> Type) where
- type EmacsRef m :: k -> Type
- type EmacsReturn m :: k -> Type
type EmacsFunction req opt rest (s :: k) (m :: k -> Type -> Type) = (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef m s) -> m s (EmacsReturn m s)
type EmacsFunctionExtra req opt rest extra (s :: k) (m :: k -> Type -> Type) = (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef m s) -> Ptr extra -> m s (EmacsReturn m s)
type UserPtrFinaliserType a = Ptr a -> IO ()
type UserPtrFinaliser a = FunPtr (UserPtrFinaliserType a)
data Nat
- = Z
- | S Nat
data R a b = R !a !b
data O a b = O !(Maybe a) !b
newtype Rest a = Rest [a]
data Stop a = Stop
data EmacsError = EmacsError {
- emacsErrMsg :: Doc Void
- emacsErrData :: Doc Void
- emacsErrStack :: CallStack
}
data EmacsInternalError = EmacsInternalError {
- emacsInternalErrMsg :: Doc Void
- emacsInternalErrStack :: CallStack
}
reportAllErrorsToEmacs :: Env -> IO a -> ((Throws EmacsInternalError, Throws EmacsError, Throws UserError, Throws EmacsThrow) => IO a) -> IO a
data EmacsM s a
runEmacsM :: Env -> (forall s. EmacsM s a) -> IO a
module Emacs.Module.Functions
module Data.Emacs.Module.Value
data Env
class Monad m => MonadThrow (m :: * -> *)
class X e => Throws e

Generic interface

class MonadEmacs (m :: k -> Type -> Type) where Source #

Associated Types

type EmacsRef m :: k -> Type Source #

Emacs value that is managed by the m monad. Will be cleaned up after m finishes its execution.

type EmacsReturn m :: k -> Type Source #

Type of values that Haskell functions may returns to Emacs.

Methods

produceRef :: EmacsRef m s -> m s (EmacsReturn m s) Source #

Return an EmacsRef back to Emacs.

nonLocalExitCheck :: WithCallStack => m s (FuncallExit ()) Source #

Check whether a non-local exit is pending.

nonLocalExitGet :: WithCallStack => m s (FuncallExit (EmacsRef m s, EmacsRef m s)) Source #

Check whether a non-local exit is pending and get detailed data in case it is.

nonLocalExitSignal Source #

Arguments

:: WithCallStack
=> EmacsRef m s	Error symbol
-> [EmacsRef m s]	Error data, will be converted to a list as Emacs API expects.
-> m s ()

Equivalent to Emacs's signal function.

NB if a non-local exit is alredy pending, this function will not overwrite it. In order to do that, use nonLocalExitClear.

nonLocalExitThrow Source #

Arguments

:: WithCallStack
=> EmacsRef m s	Tag
-> EmacsRef m s	Data
-> m s ()

Equivalent to Emacs's throw function.

NB if a non-local exit is alredy pending, this function will not overwrite it. In order to do that, use nonLocalExitClear.

nonLocalExitClear :: WithCallStack => m s () Source #

Clean any pending local exits.

freeValue :: WithCallStack => EmacsRef m s -> m s () Source #

Make value eligible for collection during next GC within Emacs.

makeFunctionExtra Source #

Arguments

:: (WithCallStack, EmacsInvocation req opt rest, GetArities req opt rest)
=> (forall s'. EmacsFunctionExtra req opt rest extra s' m)	Haskell function to export
-> ByteString	Documentation
-> Ptr extra	Extra data to be passed to the Haskell function
-> m s (EmacsRef m s)

Make Haskell function available as an anonymoucs Emacs function. In order to be able to use it later from Emacs it should be fed into bindFunction.

NB Each call to this function produces a small memory leak that will not be freed up. Hence, try not to create unbounded number of functions. This happens because GHC has to generate some wrapping code to convert between ccall and Haskell calling convention each time a function is exported. It is possible to free this code after function will not be used, but it's currently not supported.

funcall Source #

Arguments

:: WithCallStack
=> SymbolName	Function name
-> [EmacsRef m s]	Arguments
-> m s (EmacsRef m s)

Invoke an Emacs function that may call back into Haskell.

funcallPrimitive Source #

Arguments

:: WithCallStack
=> SymbolName	Function name
-> [EmacsRef m s]	Arguments
-> m s (EmacsRef m s)

Invoke an Emacs function. The function should be simple and must not call back into Haskell.

funcallPrimitive_ Source #

Arguments

:: WithCallStack
=> SymbolName	Function name
-> [EmacsRef m s]	Arguments
-> m s ()

Invoke an Emacs function and ignore its result. The function should be simple and must not call back into Haskell.

intern :: WithCallStack => SymbolName -> m s (EmacsRef m s) Source #

Convert a string to an Emacs symbol.

typeOf :: WithCallStack => EmacsRef m s -> m s (EmacsRef m s) Source #

Get type of an Emacs value as an Emacs symbol.

isNotNil :: WithCallStack => EmacsRef m s -> m s Bool Source #

Check whether Emacs value is not nil.

eq :: WithCallStack => EmacsRef m s -> EmacsRef m s -> m s Bool Source #

Primitive equality. Tests whether two symbols, integers or characters are the equal, but not much more. For more complete equality comparison do

funcall [esym|equal|] [x, y]

extractWideInteger :: WithCallStack => EmacsRef m s -> m s Int64 Source #

Try to unpack a wide integer from a value.

makeWideInteger :: WithCallStack => Int64 -> m s (EmacsRef m s) Source #

Pack a wide integer for Emacs.

extractDouble :: WithCallStack => EmacsRef m s -> m s Double Source #

Try to unpack a floating-point number from a value.

makeDouble :: WithCallStack => Double -> m s (EmacsRef m s) Source #

Convert a floating-point number into Emacs value.

extractString :: WithCallStack => EmacsRef m s -> m s ByteString Source #

Extract string contents from an Emacs value.

makeString :: WithCallStack => ByteString -> m s (EmacsRef m s) Source #

Convert a utf8-encoded ByteString into an Emacs value.

extractUserPtr :: WithCallStack => EmacsRef m s -> m s (Ptr a) Source #

Extract a user pointer from an Emacs value.

makeUserPtr Source #

Arguments

:: WithCallStack
=> UserPtrFinaliser a	Finalisation action that will be executed when user pointer gets garbage-collected by Emacs.
-> Ptr a
-> m s (EmacsRef m s)

Pack a user pointer into an Emacs value.

assignUserPtr :: WithCallStack => EmacsRef m s -> Ptr a -> m s () Source #

Set user pointer to a new value

extractUserPtrFinaliser :: WithCallStack => EmacsRef m s -> m s (UserPtrFinaliser a) Source #

Extract a finaliser from an user_ptr.

assignUserPtrFinaliser :: WithCallStack => EmacsRef m s -> UserPtrFinaliser a -> m s () Source #

Assign new finaliser into an user_ptr.

vecGet :: WithCallStack => EmacsRef m s -> Int -> m s (EmacsRef m s) Source #

Extract an element from an Emacs vector.

vecSet Source #

Arguments

:: WithCallStack
=> EmacsRef m s	Vector
-> Int	Index
-> EmacsRef m s	New value
-> m s ()

Assign an element into an Emacs vector.

vecSize :: WithCallStack => EmacsRef m s -> m s Int Source #

Get size of an Emacs vector.

Instances

(Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError) => MonadEmacs EmacsM Source #

Instance details

Defined in Emacs.Module.Monad

Associated Types

type EmacsRef EmacsM :: k -> Type Source #

type EmacsReturn EmacsM :: k -> Type Source #

Methods

produceRef :: EmacsRef EmacsM s -> EmacsM s (EmacsReturn EmacsM s) Source #

nonLocalExitCheck :: WithCallStack => EmacsM s (FuncallExit ()) Source #

nonLocalExitGet :: WithCallStack => EmacsM s (FuncallExit (EmacsRef EmacsM s, EmacsRef EmacsM s)) Source #

nonLocalExitSignal :: WithCallStack => EmacsRef EmacsM s -> [EmacsRef EmacsM s] -> EmacsM s () Source #

nonLocalExitThrow :: WithCallStack => EmacsRef EmacsM s -> EmacsRef EmacsM s -> EmacsM s () Source #

nonLocalExitClear :: WithCallStack => EmacsM s () Source #

freeValue :: WithCallStack => EmacsRef EmacsM s -> EmacsM s () Source #

makeFunctionExtra :: (WithCallStack, EmacsInvocation req opt rest, GetArities req opt rest) => (forall (s' :: k). (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef EmacsM s') -> Ptr extra -> EmacsM s' (EmacsReturn EmacsM s')) -> ByteString -> Ptr extra -> EmacsM s (EmacsRef EmacsM s) Source #

funcall :: WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s (EmacsRef EmacsM s) Source #

funcallPrimitive :: WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s (EmacsRef EmacsM s) Source #

funcallPrimitive_ :: WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s () Source #

intern :: WithCallStack => SymbolName -> EmacsM s (EmacsRef EmacsM s) Source #

typeOf :: WithCallStack => EmacsRef EmacsM s -> EmacsM s (EmacsRef EmacsM s) Source #

isNotNil :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Bool Source #

eq :: WithCallStack => EmacsRef EmacsM s -> EmacsRef EmacsM s -> EmacsM s Bool Source #

extractWideInteger :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Int64 Source #

makeWideInteger :: WithCallStack => Int64 -> EmacsM s (EmacsRef EmacsM s) Source #

extractDouble :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Double Source #

makeDouble :: WithCallStack => Double -> EmacsM s (EmacsRef EmacsM s) Source #

extractString :: WithCallStack => EmacsRef EmacsM s -> EmacsM s ByteString Source #

makeString :: WithCallStack => ByteString -> EmacsM s (EmacsRef EmacsM s) Source #

extractUserPtr :: WithCallStack => EmacsRef EmacsM s -> EmacsM s (Ptr a) Source #

makeUserPtr :: WithCallStack => UserPtrFinaliser a -> Ptr a -> EmacsM s (EmacsRef EmacsM s) Source #

assignUserPtr :: WithCallStack => EmacsRef EmacsM s -> Ptr a -> EmacsM s () Source #

extractUserPtrFinaliser :: WithCallStack => EmacsRef EmacsM s -> EmacsM s (UserPtrFinaliser a) Source #

assignUserPtrFinaliser :: WithCallStack => EmacsRef EmacsM s -> UserPtrFinaliser a -> EmacsM s () Source #

vecGet :: WithCallStack => EmacsRef EmacsM s -> Int -> EmacsM s (EmacsRef EmacsM s) Source #

vecSet :: WithCallStack => EmacsRef EmacsM s -> Int -> EmacsRef EmacsM s -> EmacsM s () Source #

vecSize :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Int Source #

Type synonyms

type EmacsFunction req opt rest (s :: k) (m :: k -> Type -> Type) = (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef m s) -> m s (EmacsReturn m s) Source #

type EmacsFunctionExtra req opt rest extra (s :: k) (m :: k -> Type -> Type) = (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef m s) -> Ptr extra -> m s (EmacsReturn m s) Source #

type UserPtrFinaliserType a = Ptr a -> IO () Source #

type UserPtrFinaliser a = FunPtr (UserPtrFinaliserType a) Source #

Types for defining functions

data Nat Source #

Constructors

Z
S Nat

data R a b Source #

Required argument.

Constructors

R !a !b

data O a b Source #

Optional argument.

Constructors

O !(Maybe a) !b

newtype Rest a Source #

All other arguments as a list.

Constructors

Rest [a]

data Stop a Source #

No more arguments.

Constructors

Stop

Errors

data EmacsError Source #

A high-level error thrown when an Emacs function fails.

Constructors

EmacsError
Fields emacsErrMsg :: Doc Void emacsErrData :: Doc Void emacsErrStack :: CallStack

Instances

Show EmacsError Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> EmacsError -> ShowS # show :: EmacsError -> String # showList :: [EmacsError] -> ShowS #
Exception EmacsError Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: EmacsError -> SomeException # fromException :: SomeException -> Maybe EmacsError # displayException :: EmacsError -> String #
Pretty EmacsError Source #
Instance details Defined in Emacs.Module.Errors Methods pretty :: EmacsError -> Doc ann # prettyList :: [EmacsError] -> Doc ann #

data EmacsInternalError Source #

A low-level error thrown when assumptions of this package are violated and it's not safe to proceed further.

Constructors

EmacsInternalError
Fields emacsInternalErrMsg :: Doc Void emacsInternalErrStack :: CallStack

Instances

Show EmacsInternalError Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> EmacsInternalError -> ShowS # show :: EmacsInternalError -> String # showList :: [EmacsInternalError] -> ShowS #
Exception EmacsInternalError Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: EmacsInternalError -> SomeException # fromException :: SomeException -> Maybe EmacsInternalError # displayException :: EmacsInternalError -> String #
Pretty EmacsInternalError Source #
Instance details Defined in Emacs.Module.Errors Methods pretty :: EmacsInternalError -> Doc ann # prettyList :: [EmacsInternalError] -> Doc ann #

reportAllErrorsToEmacs Source #

Arguments

:: Env
-> IO a	Result to return on error.
-> ((Throws EmacsInternalError, Throws EmacsError, Throws UserError, Throws EmacsThrow) => IO a)
-> IO a

Catch all errors this package might throw in an IO action and make Emacs aware of them.

This is a convenience function intended to be used around exported initialise entry point into an Emacs module.

EmacsM

data EmacsM s a Source #

Instances

MonadBase IO (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods liftBase :: IO α -> EmacsM s α #
MonadBaseControl IO (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Associated Types type StM (EmacsM s) a :: * # Methods liftBaseWith :: (RunInBase (EmacsM s) IO -> IO a) -> EmacsM s a # restoreM :: StM (EmacsM s) a -> EmacsM s a #
Monad (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods (>>=) :: EmacsM s a -> (a -> EmacsM s b) -> EmacsM s b # (>>) :: EmacsM s a -> EmacsM s b -> EmacsM s b # return :: a -> EmacsM s a # fail :: String -> EmacsM s a #
Functor (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods fmap :: (a -> b) -> EmacsM s a -> EmacsM s b # (<$) :: a -> EmacsM s b -> EmacsM s a #
MonadFix (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods mfix :: (a -> EmacsM s a) -> EmacsM s a #
Applicative (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods pure :: a -> EmacsM s a # (<>) :: EmacsM s (a -> b) -> EmacsM s a -> EmacsM s b # liftA2 :: (a -> b -> c) -> EmacsM s a -> EmacsM s b -> EmacsM s c # (>) :: EmacsM s a -> EmacsM s b -> EmacsM s b # (<*) :: EmacsM s a -> EmacsM s b -> EmacsM s a #
MonadIO (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods liftIO :: IO a -> EmacsM s a #
MonadThrow (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods throwM :: Exception e => e -> EmacsM s a #
MonadCatch (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods catch :: Exception e => EmacsM s a -> (e -> EmacsM s a) -> EmacsM s a #
MonadMask (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods mask :: ((forall a. EmacsM s a -> EmacsM s a) -> EmacsM s b) -> EmacsM s b # uninterruptibleMask :: ((forall a. EmacsM s a -> EmacsM s a) -> EmacsM s b) -> EmacsM s b # generalBracket :: EmacsM s a -> (a -> ExitCase b -> EmacsM s c) -> (a -> EmacsM s b) -> EmacsM s (b, c) #
MonadResource (EmacsM s) Source #
Instance details Defined in Emacs.Module.Monad Methods liftResourceT :: ResourceT IO a -> EmacsM s a #
(Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError) => MonadEmacs EmacsM Source #
Instance details Defined in Emacs.Module.Monad Associated Types type EmacsRef EmacsM :: k -> Type Source # type EmacsReturn EmacsM :: k -> Type Source # Methods produceRef :: EmacsRef EmacsM s -> EmacsM s (EmacsReturn EmacsM s) Source # nonLocalExitCheck :: WithCallStack => EmacsM s (FuncallExit ()) Source # nonLocalExitGet :: WithCallStack => EmacsM s (FuncallExit (EmacsRef EmacsM s, EmacsRef EmacsM s)) Source # nonLocalExitSignal :: WithCallStack => EmacsRef EmacsM s -> [EmacsRef EmacsM s] -> EmacsM s () Source # nonLocalExitThrow :: WithCallStack => EmacsRef EmacsM s -> EmacsRef EmacsM s -> EmacsM s () Source # nonLocalExitClear :: WithCallStack => EmacsM s () Source # freeValue :: WithCallStack => EmacsRef EmacsM s -> EmacsM s () Source # makeFunctionExtra :: (WithCallStack, EmacsInvocation req opt rest, GetArities req opt rest) => (forall (s' :: k). (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef EmacsM s') -> Ptr extra -> EmacsM s' (EmacsReturn EmacsM s')) -> ByteString -> Ptr extra -> EmacsM s (EmacsRef EmacsM s) Source # funcall :: WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s (EmacsRef EmacsM s) Source # funcallPrimitive :: WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s (EmacsRef EmacsM s) Source # funcallPrimitive_ :: WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s () Source # intern :: WithCallStack => SymbolName -> EmacsM s (EmacsRef EmacsM s) Source # typeOf :: WithCallStack => EmacsRef EmacsM s -> EmacsM s (EmacsRef EmacsM s) Source # isNotNil :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Bool Source # eq :: WithCallStack => EmacsRef EmacsM s -> EmacsRef EmacsM s -> EmacsM s Bool Source # extractWideInteger :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Int64 Source # makeWideInteger :: WithCallStack => Int64 -> EmacsM s (EmacsRef EmacsM s) Source # extractDouble :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Double Source # makeDouble :: WithCallStack => Double -> EmacsM s (EmacsRef EmacsM s) Source # extractString :: WithCallStack => EmacsRef EmacsM s -> EmacsM s ByteString Source # makeString :: WithCallStack => ByteString -> EmacsM s (EmacsRef EmacsM s) Source # extractUserPtr :: WithCallStack => EmacsRef EmacsM s -> EmacsM s (Ptr a) Source # makeUserPtr :: WithCallStack => UserPtrFinaliser a -> Ptr a -> EmacsM s (EmacsRef EmacsM s) Source # assignUserPtr :: WithCallStack => EmacsRef EmacsM s -> Ptr a -> EmacsM s () Source # extractUserPtrFinaliser :: WithCallStack => EmacsRef EmacsM s -> EmacsM s (UserPtrFinaliser a) Source # assignUserPtrFinaliser :: WithCallStack => EmacsRef EmacsM s -> UserPtrFinaliser a -> EmacsM s () Source # vecGet :: WithCallStack => EmacsRef EmacsM s -> Int -> EmacsM s (EmacsRef EmacsM s) Source # vecSet :: WithCallStack => EmacsRef EmacsM s -> Int -> EmacsRef EmacsM s -> EmacsM s () Source # vecSize :: WithCallStack => EmacsRef EmacsM s -> EmacsM s Int Source #
type StM (EmacsM s) a Source #
Instance details Defined in Emacs.Module.Monad type StM (EmacsM s) a
type EmacsRef EmacsM Source #
Instance details Defined in Emacs.Module.Monad type EmacsRef EmacsM = Value
type EmacsReturn EmacsM Source #
Instance details Defined in Emacs.Module.Monad type EmacsReturn EmacsM = EmacsRef EmacsM

runEmacsM :: Env -> (forall s. EmacsM s a) -> IO a Source #

Reexports

module Emacs.Module.Functions

module Data.Emacs.Module.Value

data Env Source #

Emacs environment, right from the 'emacs-module.h'.

Third-party reexports

class Monad m => MonadThrow (m :: * -> *) #

A class for monads in which exceptions may be thrown.

Instances should obey the following law:

throwM e >> x = throwM e

In other words, throwing an exception short-circuits the rest of the monadic computation.

Minimal complete definition

throwM

Instances

MonadThrow []
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> [a] #
MonadThrow Maybe
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> Maybe a #
MonadThrow IO
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> IO a #
MonadThrow Q
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> Q a #
MonadThrow STM
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> STM a #
e ~ SomeException => MonadThrow (Either e)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e0 => e0 -> Either e a #
MonadThrow m => MonadThrow (MaybeT m)	Throws exceptions into the base monad.
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> MaybeT m a #
MonadThrow m => MonadThrow (ListT m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> ListT m a #
MonadThrow m => MonadThrow (ResourceT m)
Instance details Defined in Control.Monad.Trans.Resource.Internal Methods throwM :: Exception e => e -> ResourceT m a #
MonadThrow (EmacsM s) #
Instance details Defined in Emacs.Module.Monad Methods throwM :: Exception e => e -> EmacsM s a #
MonadThrow m => MonadThrow (ExceptT e m)	Throws exceptions into the base monad.
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e0 => e0 -> ExceptT e m a #
(MonadThrow m, Monoid w) => MonadThrow (WriterT w m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> WriterT w m a #
MonadThrow m => MonadThrow (StateT s m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> StateT s m a #
(Error e, MonadThrow m) => MonadThrow (ErrorT e m)	Throws exceptions into the base monad.
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e0 => e0 -> ErrorT e m a #
MonadThrow m => MonadThrow (IdentityT m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> IdentityT m a #
MonadThrow m => MonadThrow (StateT s m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> StateT s m a #
(MonadThrow m, Monoid w) => MonadThrow (WriterT w m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> WriterT w m a #
MonadThrow m => MonadThrow (ReaderT r m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> ReaderT r m a #
MonadThrow m => MonadThrow (ContT r m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> ContT r m a #
(MonadThrow m, Monoid w) => MonadThrow (RWST r w s m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> RWST r w s m a #
(MonadThrow m, Monoid w) => MonadThrow (RWST r w s m)
Instance details Defined in Control.Monad.Catch Methods throwM :: Exception e => e -> RWST r w s m a #

class X e => Throws e #

A Throws e constraint indicates a computation may throw synchronous exception e. Introduce a constraint with throw, and discharge it with catch.

You may ignore the X superclass; it exists only to prevent additional Throws instances from being created.

Instances

Throws (Catch a)
Instance details Defined in Control.Exception.Safe.Checked