Safe Haskell	None

Data.Acquire

Description

This was previously known as the Resource monad. However, that term is confusing next to the ResourceT transformer, so it has been renamed.

Synopsis

Documentation

data Acquire a Source

A method for acquiring a scarce resource, providing the means of freeing it when no longer needed. This data type provides Functor@Applicative@Monad instances for composing different resources together. You can allocate these resources using either the bracket pattern (via with) or using ResourceT (via allocateAcquire).

This concept was originally introduced by Gabriel Gonzalez and described at: http://www.haskellforall.com/2013/06/the-resource-applicative.html. The implementation in this package is slightly different, due to taking a different approach to async exception safety.

Since 1.1.0

Instances

Monad Acquire
Functor Acquire
Typeable1 Acquire
Applicative Acquire
MonadIO Acquire
MonadBase IO Acquire

with :: MonadBaseControl IO m => Acquire a -> (a -> m b) -> m bSource

Allocate the given resource and provide it to the provided function. The resource will be freed as soon as the inner block is exited, whether normally or via an exception. This function is similar in function to bracket.

Since 1.1.0

mkAcquire Source

Arguments

:: IO a	acquire the resource
-> (a -> IO ())	free the resource
-> Acquire a

Create an Acquire value using the given allocate and free functions.

Since 1.1.0

allocateAcquire :: MonadResource m => Acquire a -> m (ReleaseKey, a)Source

Allocate a resource and register an action with the MonadResource to free the resource.

Since 1.1.0