forked from loafle/openapi-generator-original
4 lines
12 KiB
HTML
4 lines
12 KiB
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>OpenAPIPetstore.Logging</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="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><p class="caption">openapi-petstore-0.1.0.0: Auto-generated openapi-petstore API Client</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">OpenAPIPetstore.Logging</p></div><div id="table-of-contents"><p class="caption">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 id="description"><p class="caption">Description</p><div class="doc"><p>Katip Logging functions</p></div></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">type</span> <a href="#t:LogExecWithContext">LogExecWithContext</a> = <span class="keyword">forall</span> m. <a href="../base-4.10.1.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> -> <a href="OpenAPIPetstore-Logging.html#t:LogExec">LogExec</a> m</li><li class="src short"><span class="keyword">type</span> <a href="#t:LogExec">LogExec</a> m = <span class="keyword">forall</span> a. <a href="../katip-0.5.4.0/Katip-Core.html#t:KatipT">KatipT</a> m a -> m a</li><li class="src short"><span class="keyword">type</span> <a href="#t:LogContext">LogContext</a> = <a href="../katip-0.5.4.0/Katip-Core.html#t:LogEnv">LogEnv</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:LogLevel">LogLevel</a> = <a href="../katip-0.5.4.0/Katip-Core.html#t:Severity">Severity</a></li><li class="src short"><a href="#v:initLogContext">initLogContext</a> :: <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a></li><li class="src short"><a href="#v:runDefaultLogExecWithContext">runDefaultLogExecWithContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a></li><li class="src short"><a href="#v:stdoutLoggingExec">stdoutLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a></li><li class="src short"><a href="#v:stdoutLoggingContext">stdoutLoggingContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> -> <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a></li><li class="src short"><a href="#v:stderrLoggingExec">stderrLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a></li><li class="src short"><a href="#v:stderrLoggingContext">stderrLoggingContext</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> -> <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a></li><li class="src short"><a href="#v:runNullLogExec">runNullLogExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a></li><li class="src short"><a href="#v:_log">_log</a> :: (<a href="../base-4.10.1.0/Control-Applicative.html#t:Applicative">Applicative</a> m, <a href="../katip-0.5.4.0/Katip-Core.html#t:Katip">Katip</a> m) => <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -> <a href="OpenAPIPetstore-Logging.html#t:LogLevel">LogLevel</a> -> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -> m ()</li><li class="src short"><a href="#v:logExceptions">logExceptions</a> :: (<a href="../katip-0.5.4.0/Katip-Core.html#t:Katip">Katip</a> m, <a href="../exceptions-0.8.3/Control-Monad-Catch.html#t:MonadCatch">MonadCatch</a> m, <a href="../base-4.10.1.0/Control-Applicative.html#t:Applicative">Applicative</a> m) => <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -> m a -> m a</li><li class="src short"><a href="#v:levelInfo">levelInfo</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel">LogLevel</a></li><li class="src short"><a href="#v:levelError">levelError</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel">LogLevel</a></li><li class="src short"><a href="#v:levelDebug">levelDebug</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel">LogLevel</a></li></ul></div><div id="interface"><h1 id="g:1">Type Aliases (for compatibility)</h1><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 href="../base-4.10.1.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> -> <a href="OpenAPIPetstore-Logging.html#t:LogExec">LogExec</a> m <a href="src/OpenAPIPetstore.Logging.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 = <span class="keyword">forall</span> a. <a href="../katip-0.5.4.0/Katip-Core.html#t:KatipT">KatipT</a> m a -> m a <a href="src/OpenAPIPetstore.Logging.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> = <a href="../katip-0.5.4.0/Katip-Core.html#t:LogEnv">LogEnv</a> <a href="src/OpenAPIPetstore.Logging.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> = <a href="../katip-0.5.4.0/Katip-Core.html#t:Severity">Severity</a> <a href="src/OpenAPIPetstore.Logging.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><h1 id="g:2">default logger</h1><div class="top"><p class="src"><a id="v:initLogContext" class="def">initLogContext</a> :: <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> <a href="src/OpenAPIPetstore.Logging.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">LogExecWithContext</a> <a href="src/OpenAPIPetstore.Logging.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><h1 id="g:3">stdout logger</h1><div class="top"><p class="src"><a id="v:stdoutLoggingExec" class="def">stdoutLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a> <a href="src/OpenAPIPetstore.Logging.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">LogContext</a> -> <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> <a href="src/OpenAPIPetstore.Logging.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><h1 id="g:4">stderr logger</h1><div class="top"><p class="src"><a id="v:stderrLoggingExec" class="def">stderrLoggingExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a> <a href="src/OpenAPIPetstore.Logging.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">LogContext</a> -> <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="OpenAPIPetstore-Logging.html#t:LogContext">LogContext</a> <a href="src/OpenAPIPetstore.Logging.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><h1 id="g:5">Null logger</h1><div class="top"><p class="src"><a id="v:runNullLogExec" class="def">runNullLogExec</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogExecWithContext">LogExecWithContext</a> <a href="src/OpenAPIPetstore.Logging.html#runNullLogExec" class="link">Source</a> <a href="#v:runNullLogExec" class="selflink">#</a></p><div class="doc"><p>Disables Katip logging</p></div></div><h1 id="g:6">Log Msg</h1><div class="top"><p class="src"><a id="v:_log" class="def">_log</a> :: (<a href="../base-4.10.1.0/Control-Applicative.html#t:Applicative">Applicative</a> m, <a href="../katip-0.5.4.0/Katip-Core.html#t:Katip">Katip</a> m) => <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -> <a href="OpenAPIPetstore-Logging.html#t:LogLevel">LogLevel</a> -> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -> m () <a href="src/OpenAPIPetstore.Logging.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><h1 id="g:7">Log Exceptions</h1><div class="top"><p class="src"><a id="v:logExceptions" class="def">logExceptions</a> :: (<a href="../katip-0.5.4.0/Katip-Core.html#t:Katip">Katip</a> m, <a href="../exceptions-0.8.3/Control-Monad-Catch.html#t:MonadCatch">MonadCatch</a> m, <a href="../base-4.10.1.0/Control-Applicative.html#t:Applicative">Applicative</a> m) => <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -> m a -> m a <a href="src/OpenAPIPetstore.Logging.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><h1 id="g:8">Log Level</h1><div class="top"><p class="src"><a id="v:levelInfo" class="def">levelInfo</a> :: <a href="OpenAPIPetstore-Logging.html#t:LogLevel">LogLevel</a> <a href="src/OpenAPIPetstore.Logging.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">LogLevel</a> <a href="src/OpenAPIPetstore.Logging.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">LogLevel</a> <a href="src/OpenAPIPetstore.Logging.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.18.1</p></div></body></html> |