<!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" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>OpenAPIPetstore.Logging</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">openapi-petstore-0.1.0.0: Auto-generated openapi-petstore API Client</span><ul class="links" id="page-menu"><li><a href="src/OpenAPIPetstore.Logging.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">OpenAPIPetstore.Logging</p></div><div id="table-of-contents"><div id="contents-list"><p class="caption" onclick="window.scrollTo(0,0)">Contents</p><ul><li><a href="#g:1">Type Aliases (for compatibility)</a></li><li><a href="#g:2">default logger</a></li><li><a href="#g:3">stdout logger</a></li><li><a href="#g:4">stderr logger</a></li><li><a href="#g:5">Null logger</a></li><li><a href="#g:6">Log Msg</a></li><li><a href="#g:7">Log Exceptions</a></li><li><a href="#g:8">Log Level</a></li></ul></div></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Logging functions</p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">type</span> <a href="#t:LogExecWithContext">LogExecWithContext</a> = <span class="keyword">forall</span> m a. <a href="../base-4.17.1.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m =&gt; <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -&gt; <a href="OpenAPIPetstore-Logging.html#t:LogExec" title="OpenAPIPetstore.Logging">LogExec</a> m a</li><li class="src short"><span class="keyword">type</span> <a href="#t:LogExec">LogExec</a> m a = KatipT m a -&gt; m a</li><li class="src short"><span class="keyword">type</span> <a href="#t:LogContext">LogContext</a> = LogEnv</li><li class="src short"><span class="keyword">type</span> <a href="#t:LogLevel">LogLevel</a> = Severity</li><li class="src short"><a href="#v:initLogContext">initLogContext</a> :: <a href="../base-4.17.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a></li><li class="src short"><a href="#v:runDefaultLogExecWithContext">runDefaultLogExecWithContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a></li><li class="src short"><a href="#v:stdoutLoggingExec">stdoutLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a></li><li class="src short"><a href="#v:stdoutLoggingContext">stdoutLoggingContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -&gt; <a href="../base-4.17.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a></li><li class="src short"><a href="#v:stderrLoggingExec">stderrLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a></li><li class="src short"><a href="#v:stderrLoggingContext">stderrLoggingContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -&gt; <a href="../base-4.17.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a></li><li class="src short"><a href="#v:runNullLogExec">runNullLogExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a></li><li class="src short"><a href="#v:_log">_log</a> :: (<a href="../base-4.17.1.0/Control-Applicative.html#t:Applicative" title="Control.Applicative">Applicative</a> m, Katip m) =&gt; <a href="../text-2.0.2/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a> -&gt; <a href="../text-2.0.2/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; m ()</li><li class="src short"><a href="#v:logExceptions">logExceptions</a> :: (Katip m, <a href="../exceptions-0.10.5/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> m, <a href="../base-4.17.1.0/Control-Applicative.html#t:Applicative" title="Control.Applicative">Applicative</a> m) =&gt; <a href="../text-2.0.2/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; m a -&gt; m a</li><li class="src short"><a href="#v:levelInfo">levelInfo</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a></li><li class="src short"><a href="#v:levelError">levelError</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a></li><li class="src short"><a href="#v:levelDebug">levelDebug</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a></li></ul></details></div><div id="interface"><a href="#g:1" id="g:1"><h1>Type Aliases (for compatibility)</h1></a><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:LogExecWithContext" class="def">LogExecWithContext</a> = <span class="keyword">forall</span> m a. <a href="../base-4.17.1.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m =&gt; <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -&gt; <a href="OpenAPIPetstore-Logging.html#t:LogExec" title="OpenAPIPetstore.Logging">LogExec</a> m a <a href="src/OpenAPIPetstore.LoggingKatip.html#LogExecWithContext" class="link">Source</a> <a href="#t:LogExecWithContext" class="selflink">#</a></p><div class="doc"><p>Runs a Katip logging block with the Log environment</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:LogExec" class="def">LogExec</a> m a = KatipT m a -&gt; m a <a href="src/OpenAPIPetstore.LoggingKatip.html#LogExec" class="link">Source</a> <a href="#t:LogExec" class="selflink">#</a></p><div class="doc"><p>A Katip logging block</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:LogContext" class="def">LogContext</a> = LogEnv <a href="src/OpenAPIPetstore.LoggingKatip.html#LogContext" class="link">Source</a> <a href="#t:LogContext" class="selflink">#</a></p><div class="doc"><p>A Katip Log environment</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:LogLevel" class="def">LogLevel</a> = Severity <a href="src/OpenAPIPetstore.LoggingKatip.html#LogLevel" class="link">Source</a> <a href="#t:LogLevel" class="selflink">#</a></p><div class="doc"><p>A Katip Log severity</p></div></div><a href="#g:2" id="g:2"><h1>default logger</h1></a><div class="top"><p class="src"><a id="v:initLogContext" class="def">initLogContext</a> :: <a href="../base-4.17.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#initLogContext" class="link">Source</a> <a href="#v:initLogContext" class="selflink">#</a></p><div class="doc"><p>the default log environment</p></div></div><div class="top"><p class="src"><a id="v:runDefaultLogExecWithContext" class="def">runDefaultLogExecWithContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#runDefaultLogExecWithContext" class="link">Source</a> <a href="#v:runDefaultLogExecWithContext" class="selflink">#</a></p><div class="doc"><p>Runs a Katip logging block with the Log environment</p></div></div><a href="#g:3" id="g:3"><h1>stdout logger</h1></a><div class="top"><p class="src"><a id="v:stdoutLoggingExec" class="def">stdoutLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#stdoutLoggingExec" class="link">Source</a> <a href="#v:stdoutLoggingExec" class="selflink">#</a></p><div class="doc"><p>Runs a Katip logging block with the Log environment</p></div></div><div class="top"><p class="src"><a id="v:stdoutLoggingContext" class="def">stdoutLoggingContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -&gt; <a href="../base-4.17.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#stdoutLoggingContext" class="link">Source</a> <a href="#v:stdoutLoggingContext" class="selflink">#</a></p><div class="doc"><p>A Katip Log environment which targets stdout</p></div></div><a href="#g:4" id="g:4"><h1>stderr logger</h1></a><div class="top"><p class="src"><a id="v:stderrLoggingExec" class="def">stderrLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#stderrLoggingExec" class="link">Source</a> <a href="#v:stderrLoggingExec" class="selflink">#</a></p><div class="doc"><p>Runs a Katip logging block with the Log environment</p></div></div><div class="top"><p class="src"><a id="v:stderrLoggingContext" class="def">stderrLoggingContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -&gt; <a href="../base-4.17.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#stderrLoggingContext" class="link">Source</a> <a href="#v:stderrLoggingContext" class="selflink">#</a></p><div class="doc"><p>A Katip Log environment which targets stderr</p></div></div><a href="#g:5" id="g:5"><h1>Null logger</h1></a><div class="top"><p class="src"><a id="v:runNullLogExec" class="def">runNullLogExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext" title="OpenAPIPetstore.Logging">LogExecWithContext</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#runNullLogExec" class="link">Source</a> <a href="#v:runNullLogExec" class="selflink">#</a></p><div class="doc"><p>Disables Katip logging</p></div></div><a href="#g:6" id="g:6"><h1>Log Msg</h1></a><div class="top"><p class="src"><a id="v:_log" class="def">_log</a> :: (<a href="../base-4.17.1.0/Control-Applicative.html#t:Applicative" title="Control.Applicative">Applicative</a> m, Katip m) =&gt; <a href="../text-2.0.2/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a> -&gt; <a href="../text-2.0.2/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; m () <a href="src/OpenAPIPetstore.LoggingKatip.html#_log" class="link">Source</a> <a href="#v:_log" class="selflink">#</a></p><div class="doc"><p>Log a katip message</p></div></div><a href="#g:7" id="g:7"><h1>Log Exceptions</h1></a><div class="top"><p class="src"><a id="v:logExceptions" class="def">logExceptions</a> :: (Katip m, <a href="../exceptions-0.10.5/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> m, <a href="../base-4.17.1.0/Control-Applicative.html#t:Applicative" title="Control.Applicative">Applicative</a> m) =&gt; <a href="../text-2.0.2/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; m a -&gt; m a <a href="src/OpenAPIPetstore.LoggingKatip.html#logExceptions" class="link">Source</a> <a href="#v:logExceptions" class="selflink">#</a></p><div class="doc"><p>re-throws exceptions after logging them</p></div></div><a href="#g:8" id="g:8"><h1>Log Level</h1></a><div class="top"><p class="src"><a id="v:levelInfo" class="def">levelInfo</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#levelInfo" class="link">Source</a> <a href="#v:levelInfo" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:levelError" class="def">levelError</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#levelError" class="link">Source</a> <a href="#v:levelError" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:levelDebug" class="def">levelDebug</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel" title="OpenAPIPetstore.Logging">LogLevel</a> <a href="src/OpenAPIPetstore.LoggingKatip.html#levelDebug" class="link">Source</a> <a href="#v:levelDebug" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.27.0</p></div></body></html>