<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Control.Monad.Invert</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[ window.onload = function () {pageLoad();setSynopsis("mini_Control-Monad-Invert.html");}; //]]> </script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Monad-Invert.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">neither-0.1.0: Provide versions of Either with good monad and applicative instances.</p></div><div id="content"><div id="module-header"><p class="caption">Control.Monad.Invert</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Typeclass </a></li><li><a href="#g:2">Exceptions </a></li><li><a href="#g:3">Memory allocation </a></li></ul></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="#t:MonadInvertIO">MonadInvertIO</a> m <span class="keyword">where</span><ul class="subs"><li><span class="keyword">data</span> <a href="#t:InvertedIO">InvertedIO</a> m :: * -> *</li><li><span class="keyword">type</span> <a href="#t:InvertedArg">InvertedArg</a> m </li><li><a href="#v:invertIO">invertIO</a> :: m a -> <a href="Control-Monad-Invert.html#t:InvertedArg">InvertedArg</a> m -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Control-Monad-Invert.html#t:InvertedIO">InvertedIO</a> m a)</li><li><a href="#v:revertIO">revertIO</a> :: (<a href="Control-Monad-Invert.html#t:InvertedArg">InvertedArg</a> m -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Control-Monad-Invert.html#t:InvertedIO">InvertedIO</a> m a)) -> m a</li></ul></li><li class="src short"><a href="#v:finally">finally</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m b -> m a</li><li class="src short"><a href="#v:catch">catch</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Control-Exception-Base.html#t:Exception">Exception</a> e, <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m) => m a -> (e -> m a) -> m a</li><li class="src short"><a href="#v:block">block</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m a</li><li class="src short"><a href="#v:unblock">unblock</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m a</li><li class="src short"><a href="#v:bracket">bracket</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> (a -> m b) -> (a -> m c) -> m c</li><li class="src short"><a href="#v:bracket_">bracket_</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m b -> m c -> m c</li><li class="src short"><a href="#v:onException">onException</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m b -> m a</li><li class="src short"><a href="#v:alloca">alloca</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Storable.html#t:Storable">Storable</a> a, <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m) => (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a -> m b) -> m b</li><li class="src short"><a href="#v:allocaBytes">allocaBytes</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a -> m b) -> m b</li><li class="src short"><a href="#v:withForeignPtr">withForeignPtr</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-ForeignPtr.html#t:ForeignPtr">ForeignPtr</a> a -> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a -> m b) -> m b</li></ul></div><div id="interface"><h1 id="g:1">Typeclass </h1><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a name="t:MonadInvertIO" class="def">MonadInvertIO</a> m <span class="keyword">where</span><a href="src/Control-Monad-Invert.html#MonadInvertIO" class="link">Source</a></p><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">data</span> <a name="t:InvertedIO" class="def">InvertedIO</a> m :: * -> *<a href="src/Control-Monad-Invert.html#InvertedIO" class="link">Source</a></p><p class="src"><span class="keyword">type</span> <a name="t:InvertedArg" class="def">InvertedArg</a> m <a href="src/Control-Monad-Invert.html#InvertedArg" class="link">Source</a></p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:invertIO" class="def">invertIO</a> :: m a -> <a href="Control-Monad-Invert.html#t:InvertedArg">InvertedArg</a> m -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Control-Monad-Invert.html#t:InvertedIO">InvertedIO</a> m a)<a href="src/Control-Monad-Invert.html#invertIO" class="link">Source</a></p><p class="src"><a name="v:revertIO" class="def">revertIO</a> :: (<a href="Control-Monad-Invert.html#t:InvertedArg">InvertedArg</a> m -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Control-Monad-Invert.html#t:InvertedIO">InvertedIO</a> m a)) -> m a<a href="src/Control-Monad-Invert.html#revertIO" class="link">Source</a></p></div><div class="subs instances"><p id="control.i:MonadInvertIO" class="caption collapser" onclick="toggleSection('i:MonadInvertIO')">Instances</p><div id="section.i:MonadInvertIO" class="show"><table><tr><td class="src"><a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> (<a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-Trans-Identity.html#t:IdentityT">IdentityT</a> m)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Monoid.html#t:Monoid">Monoid</a> w, <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m) => <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> (<a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-Trans-Writer-Lazy.html#t:WriterT">WriterT</a> w m)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> (<a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-Trans-State-Lazy.html#t:StateT">StateT</a> s m)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> (<a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-Trans-Reader.html#t:ReaderT">ReaderT</a> r m)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-Trans-Error.html#t:Error">Error</a> e, <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m) => <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> (<a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-Trans-Error.html#t:ErrorT">ErrorT</a> e m)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> (<a href="Data-Neither.html#t:MEitherT">MEitherT</a> e m)</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Exceptions </h1><div class="top"><p class="src"><a name="v:finally" class="def">finally</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m b -> m a<a href="src/Control-Monad-Invert.html#finally" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:catch" class="def">catch</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Control-Exception-Base.html#t:Exception">Exception</a> e, <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m) => m a -> (e -> m a) -> m a<a href="src/Control-Monad-Invert.html#catch" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:block" class="def">block</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m a<a href="src/Control-Monad-Invert.html#block" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:unblock" class="def">unblock</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m a<a href="src/Control-Monad-Invert.html#unblock" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:bracket" class="def">bracket</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> (a -> m b) -> (a -> m c) -> m c<a href="src/Control-Monad-Invert.html#bracket" class="link">Source</a></p><div class="doc"><p>There is a very important distinction between this function and <code><a href="Control-Monad-Invert.html#v:bracket_">bracket_</a></code>: in this version, the monadic side effects from the initialization function and kept, while in bracket_ they are discarded. </p></div></div><div class="top"><p class="src"><a name="v:bracket_" class="def">bracket_</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m b -> m c -> m c<a href="src/Control-Monad-Invert.html#bracket_" class="link">Source</a></p><div class="doc"><p>See <code><a href="Control-Monad-Invert.html#v:bracket">bracket</a></code>. </p></div></div><div class="top"><p class="src"><a name="v:onException" class="def">onException</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => m a -> m b -> m a<a href="src/Control-Monad-Invert.html#onException" class="link">Source</a></p></div><h1 id="g:3">Memory allocation </h1><div class="top"><p class="src"><a name="v:alloca" class="def">alloca</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Storable.html#t:Storable">Storable</a> a, <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m) => (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a -> m b) -> m b<a href="src/Control-Monad-Invert.html#alloca" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:allocaBytes" class="def">allocaBytes</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a -> m b) -> m b<a href="src/Control-Monad-Invert.html#allocaBytes" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:withForeignPtr" class="def">withForeignPtr</a> :: <a href="Control-Monad-Invert.html#t:MonadInvertIO">MonadInvertIO</a> m => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-ForeignPtr.html#t:ForeignPtr">ForeignPtr</a> a -> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a -> m b) -> m b<a href="src/Control-Monad-Invert.html#withForeignPtr" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>