forked from loafle/openapi-generator-original
c30a21ac3c
[haskell-http-client] Allow logger selection via cabal flags. Emit Consumes */* for requestBody when not specified
1 line
19 KiB
HTML
1 line
19 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" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><script src="haddock-bundle.min.js" async="async" 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></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>Safe</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><li><a href="#g:9">Level Filter</a></li></ul></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 href="../base-4.12.0.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m => <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -> <a href="OpenAPIPetstore-Logging.html#t:LogExec" title="OpenAPIPetstore.Logging">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="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LoggingT" title="Control.Monad.Logger">LoggingT</a> m a -> m a</li><li class="src short"><span class="keyword">type</span> <a href="#t:LogContext">LogContext</a> = <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../base-4.12.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:LogLevel">LogLevel</a> = <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a></li><li class="src short"><a href="#v:initLogContext">initLogContext</a> :: <a href="../base-4.12.0.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> -> <a href="../base-4.12.0.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> -> <a href="../base-4.12.0.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:nullLogger">nullLogger</a> :: <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:Loc" title="Control.Monad.Logger">Loc</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../fast-logger-2.4.13/System-Log-FastLogger.html#t:LogStr" title="System.Log.FastLogger">LogStr</a> -> <a href="../base-4.12.0.0/System-IO.html#t:IO" title="System.IO">IO</a> ()</li><li class="src short"><a href="#v:_log">_log</a> :: (<a href="../base-4.12.0.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:MonadLogger" title="Control.Monad.Logger">MonadLogger</a> m) => <a href="../text-1.2.3.1/Data-Text.html#t:Text" title="Data.Text">Text</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../text-1.2.3.1/Data-Text.html#t:Text" title="Data.Text">Text</a> -> m ()</li><li class="src short"><a href="#v:logExceptions">logExceptions</a> :: (<a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:MonadLogger" title="Control.Monad.Logger">MonadLogger</a> m, <a href="../exceptions-0.10.0/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> m, <a href="../base-4.12.0.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m) => <a href="../text-1.2.3.1/Data-Text.html#t:Text" title="Data.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" 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><li class="src short"><a href="#v:minLevelFilter">minLevelFilter</a> :: <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../base-4.12.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><a href="#v:infoLevelFilter">infoLevelFilter</a> :: <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../base-4.12.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</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 href="../base-4.12.0.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m => <a href="OpenAPIPetstore-Logging.html#t:LogContext" title="OpenAPIPetstore.Logging">LogContext</a> -> <a href="OpenAPIPetstore-Logging.html#t:LogExec" title="OpenAPIPetstore.Logging">LogExec</a> m <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#LogExecWithContext" class="link">Source</a> <a href="#t:LogExecWithContext" class="selflink">#</a></p><div class="doc"><p>Runs a monad-logger block with the filter predicate</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="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LoggingT" title="Control.Monad.Logger">LoggingT</a> m a -> m a <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#LogExec" class="link">Source</a> <a href="#t:LogExec" class="selflink">#</a></p><div class="doc"><p>A monad-logger 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="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../base-4.12.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#LogContext" class="link">Source</a> <a href="#t:LogContext" class="selflink">#</a></p><div class="doc"><p>A monad-logger filter predicate</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:LogLevel" class="def">LogLevel</a> = <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#LogLevel" class="link">Source</a> <a href="#t:LogLevel" class="selflink">#</a></p><div class="doc"><p>A monad-logger log level</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.12.0.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.LoggingMonadLogger.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.LoggingMonadLogger.html#runDefaultLogExecWithContext" class="link">Source</a> <a href="#v:runDefaultLogExecWithContext" class="selflink">#</a></p><div class="doc"><p>Runs a monad-logger block with the filter predicate</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.LoggingMonadLogger.html#stdoutLoggingExec" class="link">Source</a> <a href="#v:stdoutLoggingExec" class="selflink">#</a></p><div class="doc"><p>Runs a monad-logger block targeting stdout, with the filter predicate</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> -> <a href="../base-4.12.0.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.LoggingMonadLogger.html#stdoutLoggingContext" class="link">Source</a> <a href="#v:stdoutLoggingContext" class="selflink">#</a></p><div class="doc"><pre>pure</pre></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.LoggingMonadLogger.html#stderrLoggingExec" class="link">Source</a> <a href="#v:stderrLoggingExec" class="selflink">#</a></p><div class="doc"><p>Runs a monad-logger block targeting stderr, with the filter predicate</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> -> <a href="../base-4.12.0.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.LoggingMonadLogger.html#stderrLoggingContext" class="link">Source</a> <a href="#v:stderrLoggingContext" class="selflink">#</a></p><div class="doc"><pre>pure</pre></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.LoggingMonadLogger.html#runNullLogExec" class="link">Source</a> <a href="#v:runNullLogExec" class="selflink">#</a></p><div class="doc"><p>Disables monad-logger logging</p></div></div><div class="top"><p class="src"><a id="v:nullLogger" class="def">nullLogger</a> :: <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:Loc" title="Control.Monad.Logger">Loc</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../fast-logger-2.4.13/System-Log-FastLogger.html#t:LogStr" title="System.Log.FastLogger">LogStr</a> -> <a href="../base-4.12.0.0/System-IO.html#t:IO" title="System.IO">IO</a> () <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#nullLogger" class="link">Source</a> <a href="#v:nullLogger" class="selflink">#</a></p><div class="doc"><p>monad-logger which does nothing</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.12.0.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:MonadLogger" title="Control.Monad.Logger">MonadLogger</a> m) => <a href="../text-1.2.3.1/Data-Text.html#t:Text" title="Data.Text">Text</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../text-1.2.3.1/Data-Text.html#t:Text" title="Data.Text">Text</a> -> m () <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#_log" class="link">Source</a> <a href="#v:_log" class="selflink">#</a></p><div class="doc"><p>Log a message using the current time</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> :: (<a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:MonadLogger" title="Control.Monad.Logger">MonadLogger</a> m, <a href="../exceptions-0.10.0/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> m, <a href="../base-4.12.0.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m) => <a href="../text-1.2.3.1/Data-Text.html#t:Text" title="Data.Text">Text</a> -> m a -> m a <a href="src/OpenAPIPetstore.LoggingMonadLogger.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.LoggingMonadLogger.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.LoggingMonadLogger.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.LoggingMonadLogger.html#levelDebug" class="link">Source</a> <a href="#v:levelDebug" class="selflink">#</a></p></div><a href="#g:9" id="g:9"><h1>Level Filter</h1></a><div class="top"><p class="src"><a id="v:minLevelFilter" class="def">minLevelFilter</a> :: <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../base-4.12.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#minLevelFilter" class="link">Source</a> <a href="#v:minLevelFilter" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:infoLevelFilter" class="def">infoLevelFilter</a> :: <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogSource" title="Control.Monad.Logger">LogSource</a> -> <a href="../monad-logger-0.3.30/Control-Monad-Logger.html#t:LogLevel" title="Control.Monad.Logger">LogLevel</a> -> <a href="../base-4.12.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="src/OpenAPIPetstore.LoggingMonadLogger.html#infoLevelFilter" class="link">Source</a> <a href="#v:infoLevelFilter" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.22.0</p></div></body></html> |