<!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>Darcs.MonadProgress</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_Darcs-MonadProgress.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-MonadProgress.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">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.MonadProgress</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">class</span> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="#t:MonadProgress">MonadProgress</a> m <span class="keyword">where</span><ul class="subs"><li><a href="#v:runProgressActions">runProgressActions</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="Darcs-MonadProgress.html#t:ProgressAction">ProgressAction</a> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>] -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:ProgressAction">ProgressAction</a> m a = <a href="#v:ProgressAction">ProgressAction</a> {<ul class="subs"><li><a href="#v:paAction">paAction</a> :: m a</li><li><a href="#v:paMessage">paMessage</a> :: <a href="Printer.html#t:Doc">Doc</a></li><li><a href="#v:paOnError">paOnError</a> :: <a href="Printer.html#t:Doc">Doc</a></li></ul>}</li><li class="src short"><a href="#v:silentlyRunProgressActions">silentlyRunProgressActions</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="Darcs-MonadProgress.html#t:ProgressAction">ProgressAction</a> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>] -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a name="t:MonadProgress" class="def">MonadProgress</a> m <span class="keyword">where</span><a href="src/Darcs-MonadProgress.html#MonadProgress" class="link">Source</a></p><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:runProgressActions" class="def">runProgressActions</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="Darcs-MonadProgress.html#t:ProgressAction">ProgressAction</a> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>] -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-MonadProgress.html#runProgressActions" class="link">Source</a></p><div class="doc"><p>run a list of <code><a href="Darcs-MonadProgress.html#t:ProgressAction">ProgressAction</a></code>s. In some monads (typically IO-based ones),
the progress and error messages will be used. In others they will be
ignored and just the actions will be run.
</p></div></div><div class="subs instances"><p id="control.i:MonadProgress" class="caption collapser" onclick="toggleSection('i:MonadProgress')">Instances</p><div id="section.i:MonadProgress" class="show"><table><tr><td class="src"><a href="Darcs-MonadProgress.html#t:MonadProgress">MonadProgress</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-MonadProgress.html#t:MonadProgress">MonadProgress</a> RestrictedApply</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-MonadProgress.html#t:MonadProgress">MonadProgress</a> FilePathMonad</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Functor">Functor</a> m, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m) => <a href="Darcs-MonadProgress.html#t:MonadProgress">MonadProgress</a> (<a href="/usr/share/doc/ghc/html/libraries/hashed-storage-0.5.9/Storage-Hashed-Monad.html#t:TreeMonad">TreeMonad</a> m)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ProgressAction" class="def">ProgressAction</a> m a <a href="src/Darcs-MonadProgress.html#ProgressAction" class="link">Source</a></p><div class="doc"><p>a monadic action, annotated with a progress message that could be printed out
while running the action, and a message that could be printed out on error.
Actually printing out these messages is optional to allow non-IO monads to
just run the action.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ProgressAction" class="def">ProgressAction</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:paAction" class="def">paAction</a> :: m a</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:paMessage" class="def">paMessage</a> :: <a href="Printer.html#t:Doc">Doc</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:paOnError" class="def">paOnError</a> :: <a href="Printer.html#t:Doc">Doc</a></dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:silentlyRunProgressActions" class="def">silentlyRunProgressActions</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="Darcs-MonadProgress.html#t:ProgressAction">ProgressAction</a> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>] -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-MonadProgress.html#silentlyRunProgressActions" class="link">Source</a></p><div class="doc"><p>run a list of <code><a href="Darcs-MonadProgress.html#t:ProgressAction">ProgressAction</a></code>s without any feedback messages
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
