Handle exceptions thrown in IO with fused-effects.
 
 
Go to file
Rob Rix e5485955e7
Bump CI to the latest cabal.
2020-07-13 11:11:33 -04:00
.github/workflows Bump CI to the latest cabal. 2020-07-13 11:11:33 -04:00
src/Control Update all the uses of liftWith for the new ordering. 2020-07-03 13:44:08 -04:00
test Compile the README. 2019-11-01 11:30:36 -04:00
.gitignore Add travis stuff since this is now a more prominent part of the ecosystem. 2019-10-14 13:24:55 -04:00
.stylish-haskell.yaml Add the stylish-haskell config. 2020-07-03 13:39:05 -04:00
ChangeLog.md Add a changelog entry. 2020-07-13 11:10:38 -04:00
LICENSE Extract from parent project. 2019-03-19 10:24:57 -04:00
README.lhs Symlink the README. 2019-11-01 11:23:13 -04:00
README.md Compile the README. 2019-11-01 11:30:36 -04:00
Setup.hs Extract from parent project. 2019-03-19 10:24:57 -04:00
cabal.project Bump to 1.1. 2020-07-08 11:09:01 -04:00
fused-effects-exceptions.cabal Bump 8.8 to 8.8.3. 2020-07-13 11:11:05 -04:00

README.md

fused-effects-exceptions

Hackage BSD3 license Build Status

This package provides Control.Effect.Exception, a module that wraps the Control.Exception API from base with the vocabulary provided by the fused-effects library. These functions interact with GHC's support for dynamic exceptions, including functions like catch for exception handling and bracket for resource management.

Please be aware that injudicious use of these functions may provoke surprising interactions with carriers that thread a monadic state as a parameter, à la the Control.Carrier.State types provided by fused-effects. For example, a function like finally, which does not thread any state from its body to its handler block, may discard state writes in cleanup handlers:

discardsState :: IO Char
discardsState = execState 'a' ((throwIO (userError "urk") `finally` put @Char 'z')
    `catch` (\(_ :: IOException) -> pure ()))

Though the put @Char 'z' statement is evaluated, its effect is ultimately discarded; the result of executing the above is 'a'. If this behavior is a concern, a Control.Carrier.State.IORef carrier is provided, which fixes this issue given access to a MonadIO constraint. If it is not a concern (such as if the cleanup block is only run for its effects in IO), then the StateC carriers from fused-effects will suffice. For more information about the issues associated with this approach, consult Alexis King's excellent Demystifying MonadBaseControl.

Prior versions of this package provided a Catch effect; this has been excised in favor of the more-general Control.Effect.Exception, which provides more functionality without requiring any additional carriers beyond a Lift IO effect.