Cabal-2.0.1.1: doc/API/Cabal/Distribution-Utils-LogProgress.html
<!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>Distribution.Utils.LogProgress</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-2.0.1.1: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Distribution.Utils.LogProgress</p></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">data</span> <a href="#t:LogProgress">LogProgress</a> a</li><li class="src short"><a href="#v:runLogProgress">runLogProgress</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Compat-Prelude-Internal.html#t:NoCallStackIO">NoCallStackIO</a> a</li><li class="src short"><a href="#v:warnProgress">warnProgress</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/pretty-1.1.3.3/Text-PrettyPrint.html#t:Doc">Doc</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> ()</li><li class="src short"><a href="#v:infoProgress">infoProgress</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/pretty-1.1.3.3/Text-PrettyPrint.html#t:Doc">Doc</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> ()</li><li class="src short"><a href="#v:dieProgress">dieProgress</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/pretty-1.1.3.3/Text-PrettyPrint.html#t:Doc">Doc</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a</li><li class="src short"><a href="#v:addProgressCtx">addProgressCtx</a> :: CtxMsg -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:LogProgress" class="def">LogProgress</a> a <a href="#t:LogProgress" class="selflink">#</a></p><div class="doc"><p>The <code><a href="Distribution-Utils-Progress.html#t:Progress">Progress</a></code> monad with specialized logging and
error messages.</p></div><div class="subs instances"><p id="control.i:LogProgress" class="caption collapser" onclick="toggleSection('i:LogProgress')">Instances</p><div id="section.i:LogProgress" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:LogProgress:Monad:1" class="instance expander" onclick="toggleSection('i:id:LogProgress:Monad:1')"></span> <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/base-4.10.1.0/Control-Monad.html#t:Monad">Monad</a> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a></span> <a href="#t:LogProgress" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:LogProgress:Monad:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-62--62--61-">(>>=)</a> :: <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> (a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b) -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b <a href="#v:-62--62--61-" class="selflink">#</a></p><p class="src"><a href="#v:-62--62-">(>>)</a> :: <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b <a href="#v:-62--62-" class="selflink">#</a></p><p class="src"><a href="#v:return">return</a> :: a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:return" class="selflink">#</a></p><p class="src"><a href="#v:fail">fail</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/base-4.10.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:fail" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:LogProgress:Functor:2" class="instance expander" onclick="toggleSection('i:id:LogProgress:Functor:2')"></span> <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/base-4.10.1.0/Data-Functor.html#t:Functor">Functor</a> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a></span> <a href="#t:LogProgress" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:LogProgress:Functor:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:fmap">fmap</a> :: (a -> b) -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b <a href="#v:fmap" class="selflink">#</a></p><p class="src"><a href="#v:-60--36-">(<$)</a> :: a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:-60--36-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:LogProgress:Applicative:3" class="instance expander" onclick="toggleSection('i:id:LogProgress:Applicative:3')"></span> <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/base-4.10.1.0/Control-Applicative.html#t:Applicative">Applicative</a> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a></span> <a href="#t:LogProgress" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:LogProgress:Applicative:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:pure">pure</a> :: a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:pure" class="selflink">#</a></p><p class="src"><a href="#v:-60--42--62-">(<*>)</a> :: <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> (a -> b) -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b <a href="#v:-60--42--62-" class="selflink">#</a></p><p class="src"><a href="#v:liftA2">liftA2</a> :: (a -> b -> c) -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> c <a href="#v:liftA2" class="selflink">#</a></p><p class="src"><a href="#v:-42--62-">(*>)</a> :: <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b <a href="#v:-42--62-" class="selflink">#</a></p><p class="src"><a href="#v:-60--42-">(<*)</a> :: <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> b -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:-60--42-" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:runLogProgress" class="def">runLogProgress</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Compat-Prelude-Internal.html#t:NoCallStackIO">NoCallStackIO</a> a <a href="#v:runLogProgress" class="selflink">#</a></p><div class="doc"><p>Run <code><a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a></code>, outputting traces according to <code><a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></code>,
<code><a href="Distribution-Simple-Utils.html#v:die">die</a></code> if there is an error.</p></div></div><div class="top"><p class="src"><a id="v:warnProgress" class="def">warnProgress</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/pretty-1.1.3.3/Text-PrettyPrint.html#t:Doc">Doc</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> () <a href="#v:warnProgress" class="selflink">#</a></p><div class="doc"><p>Output a warning trace message in <code><a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a></code>.</p></div></div><div class="top"><p class="src"><a id="v:infoProgress" class="def">infoProgress</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/pretty-1.1.3.3/Text-PrettyPrint.html#t:Doc">Doc</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> () <a href="#v:infoProgress" class="selflink">#</a></p><div class="doc"><p>Output an informational trace message in <code><a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a></code>.</p></div></div><div class="top"><p class="src"><a id="v:dieProgress" class="def">dieProgress</a> :: <a href="file:///opt/ghc/8.2.2/share/doc/ghc-8.2.2/html/libraries/pretty-1.1.3.3/Text-PrettyPrint.html#t:Doc">Doc</a> -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:dieProgress" class="selflink">#</a></p><div class="doc"><p>Fail the computation with an error message.</p></div></div><div class="top"><p class="src"><a id="v:addProgressCtx" class="def">addProgressCtx</a> :: CtxMsg -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a -> <a href="Distribution-Utils-LogProgress.html#t:LogProgress">LogProgress</a> a <a href="#v:addProgressCtx" class="selflink">#</a></p><div class="doc"><p>Add a message to the error/warning context.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>