hackage-security- Hackage security library

Safe HaskellNone




Verification monad

data Verify a #

Verification monad

The verification monad is similar to ResourceT in intent, in that we can register handlers to be run to release resources. Unlike ResourceT, however, we maintain _two_ handlers: a cleanup handler which is run whether or not verification succeeds, and a finalisation handler which is run only if verification succeeds.

  • Cleanup handlers are registered using acquire, and are guaranteed to run just before the computation terminates (after the finalisation handler).
  • The finalisation handlers are run only when verification succeeds, and can be registered with ifVerified. Finalisation can be used for instance to update the local cache (which should only happen if verification is successful).


Monad Verify # 


(>>=) :: Verify a -> (a -> Verify b) -> Verify b #

(>>) :: Verify a -> Verify b -> Verify b #

return :: a -> Verify a #

fail :: String -> Verify a #

Functor Verify # 


fmap :: (a -> b) -> Verify a -> Verify b #

(<$) :: a -> Verify b -> Verify a #

Applicative Verify # 


pure :: a -> Verify a #

(<*>) :: Verify (a -> b) -> Verify a -> Verify b #

(*>) :: Verify a -> Verify b -> Verify b #

(<*) :: Verify a -> Verify b -> Verify a #

MonadIO Verify # 


liftIO :: IO a -> Verify a #

runVerify :: (Finaliser -> Finaliser) -> Verify a -> IO a #

Run an action in the Verify monad

acquire :: IO a -> (a -> IO ()) -> Verify a #

Acquire a resource and register the corresponding cleanup handler

NOTE: Resource acquisition happens with exceptions masked. If it is important that the resource acquistion can be timed out (or receive other kinds of asynchronous exceptions), you will need to use an interruptible operation. See http://www.well-typed.com/blog/2014/08/asynchronous-exceptions/ for details.

ifVerified :: IO () -> Verify () #

Register an action to be run only if verification succeeds

Specific resources

openTempFile #


:: FsRoot root 
=> Path root

Temp directory

-> String


-> Verify (Path Absolute, Handle) 

Create a short-lived temporary file

Creates the directory where the temp file should live if it does not exist.


liftIO :: MonadIO m => forall a. IO a -> m a #

Lift a computation from the IO monad.