resourcet-1.1.4.1: Deterministic allocation and freeing of scarce resources.

Safe HaskellNone
LanguageHaskell98

Control.Monad.Trans.Resource.Internal

Synopsis

Documentation

data InvalidAccess Source

Indicates either an error in the library, or misuse of it (e.g., a ResourceT's state is accessed after being released).

Since 0.3.0

Constructors

InvalidAccess 

Fields

functionName :: String
 

class (MonadThrow m, MonadIO m, Applicative m, MonadBase IO m) => MonadResource m where Source

A Monad which allows for safe resource allocation. In theory, any monad transformer stack included a ResourceT can be an instance of MonadResource.

Note: runResourceT has a requirement for a MonadBaseControl IO m monad, which allows control operations to be lifted. A MonadResource does not have this requirement. This means that transformers such as ContT can be an instance of MonadResource. However, the ContT wrapper will need to be unwrapped before calling runResourceT.

Since 0.3.0

Methods

liftResourceT :: ResourceT IO a -> m a Source

Lift a ResourceT IO action into the current Monad.

Since 0.4.0

data ReleaseKey Source

A lookup key for a specific release action. This value is returned by register and allocate, and is passed to release.

Since 0.3.0

Constructors

ReleaseKey !(IORef ReleaseMap) !Int 

Instances

data ReleaseMap Source

Constructors

ReleaseMap !NextKey !RefCount !(IntMap (ReleaseType -> IO ())) 
ReleaseMapClosed 

type ResIO a = ResourceT IO a Source

Convenient alias for ResourceT IO.

newtype ResourceT m a Source

The Resource transformer. This transformer keeps track of all registered actions, and calls them upon exit (via runResourceT). Actions may be registered via register, or resources may be allocated atomically via allocate. allocate corresponds closely to bracket.

Releasing may be performed before exit via the release function. This is a highly recommended optimization, as it will ensure that scarce resources are freed early. Note that calling release will deregister the action, so that a release action will only ever be called once.

Since 0.3.0

Constructors

ResourceT 

Fields

unResourceT :: IORef ReleaseMap -> m a
 

Instances

MonadTrans ResourceT 
MonadTransControl ResourceT 
MMonad ResourceT

Since 0.4.7

MFunctor ResourceT

Since 0.4.7

MonadRWS r w s m => MonadRWS r w s (ResourceT m) 
MonadBase b m => MonadBase b (ResourceT m) 
MonadBaseControl b m => MonadBaseControl b (ResourceT m) 
MonadError e m => MonadError e (ResourceT m) 
MonadWriter w m => MonadWriter w (ResourceT m) 
MonadState s m => MonadState s (ResourceT m) 
MonadReader r m => MonadReader r (ResourceT m) 
Monad m => Monad (ResourceT m) 
Functor m => Functor (ResourceT m) 
Applicative m => Applicative (ResourceT m) 
MonadIO m => MonadIO (ResourceT m) 
MonadThrow m => MonadThrow (ResourceT m) 
MonadMask m => MonadMask (ResourceT m) 
MonadCatch m => MonadCatch (ResourceT m) 
MonadCont m => MonadCont (ResourceT m) 
(MonadThrow m, MonadBase IO m, MonadIO m, Applicative m) => MonadResource (ResourceT m) 
Typeable ((* -> *) -> * -> *) ResourceT 
type StT ResourceT a = a 
type StM (ResourceT m) a = StM m a 

transResourceT :: (m a -> n b) -> ResourceT m a -> ResourceT n b Source

Transform the monad a ResourceT lives in. This is most often used to strip or add new transformers to a stack, e.g. to run a ReaderT.

Note that this function is a slight generalization of hoist.

Since 0.3.0