You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>InferBase__Logging (InferBase.InferBase__Logging)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">InferBase</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">InferBase__Logging</span></h1></header><p>log messages at different levels of verbosity</p><div class="spec module" id="module-F"><a href="#module-F" class="anchor"></a><div class="def module"><code><span class="keyword">module </span>F = Format</code></div><div class="doc"></div></div><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span><a href="../InferBase/index.html#module-Die">InferBase.Die</a></code></span></summary><div class="spec exception" id="exception-InferExternalError"><a href="#exception-InferExternalError" class="anchor"></a><div class="def exception"><code><span class="keyword">exception </span></code><code><span class="exception">InferExternalError</span><span class="keyword"> of </span>string</code></div><div class="doc"></div></div><div class="spec exception" id="exception-InferInternalError"><a href="#exception-InferInternalError" class="anchor"></a><div class="def exception"><code><span class="keyword">exception </span></code><code><span class="exception">InferInternalError</span><span class="keyword"> of </span>string</code></div><div class="doc"></div></div><div class="spec exception" id="exception-InferUserError"><a href="#exception-InferUserError" class="anchor"></a><div class="def exception"><code><span class="keyword">exception </span></code><code><span class="exception">InferUserError</span><span class="keyword"> of </span>string</code></div><div class="doc"></div></div><div class="spec exception" id="exception-InferExit"><a href="#exception-InferExit" class="anchor"></a><div class="def exception"><code><span class="keyword">exception </span></code><code><span class="exception">InferExit</span><span class="keyword"> of </span>int</code></div><div class="doc"><p>This can be used to avoid scattering exit invocations all over the codebase</p></div></div><div class="spec type" id="type-error"><a href="#type-error" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>error</code><code></code><code><span class="keyword"> = </span></code><table class="variant"><tr id="type-error.ExternalError" class="anchored"><td class="def constructor"><a href="#type-error.ExternalError" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">ExternalError</span></code></td></tr><tr id="type-error.InternalError" class="anchored"><td class="def constructor"><a href="#type-error.InternalError" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">InternalError</span></code></td></tr><tr id="type-error.UserError" class="anchored"><td class="def constructor"><a href="#type-error.UserError" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">UserError</span></code></td></tr></table><code></code></div><div class="doc"><p>kind of error for <code class="code">die</code>, with similar semantics as <code class="code">Logging.{external,internal,user}_error</code></p></div></div><div class="spec val" id="val-exit"><a href="#val-exit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>exit : int <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"></div></div><div class="spec val" id="val-exit_code_of_exception"><a href="#val-exit_code_of_exception" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>exit_code_of_except
|
|
|
|
|
|
conceivably get piped to another program, ie, almost never (use <code class="code">progress</code> instead otherwise).</p></div></div><div class="spec val" id="val-user_error"><a href="#val-user_error" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>user_error : (<span class="type-var">'a</span>, <a href="index.html#module-F">F</a>.formatter, unit) <a href="../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.format <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>bad input, etc. detected</p></div></div><div class="spec val" id="val-user_warning"><a href="#val-user_warning" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>user_warning : (<span class="type-var">'a</span>, <a href="index.html#module-F">F</a>.formatter, unit) <a href="../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.format <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"></div></div><div class="spec val" id="val-internal_error"><a href="#val-internal_error" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>internal_error : (<span class="type-var">'a</span>, <a href="index.html#module-F">F</a>.formatter, unit) <a href="../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.format <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>huho, infer has a bug</p></div></div><div class="spec val" id="val-external_error"><a href="#val-external_error" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>external_error : (<span class="type-var">'a</span>, <a href="index.html#module-F">F</a>.formatter, unit) <a href="../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.format <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>some other tool has a bug or is called wrongly</p></div></div><div class="spec val" id="val-external_warning"><a href="#val-external_warning" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>external_warning : (<span class="type-var">'a</span>, <a href="index.html#module-F">F</a>.formatter, unit) <a href="../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.format <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"></div></div><div class="spec type" id="type-debug_kind"><a href="#type-debug_kind" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>debug_kind</code><code></code><code><span class="keyword"> = </span></code><table class="variant"><tr id="type-debug_kind.Analysis" class="anchored"><td class="def constructor"><a href="#type-debug_kind.Analysis" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Analysis</span></code></td></tr><tr id="type-debug_kind.BufferOverrun" class="anchored"><td class="def constructor"><a href="#type-debug_kind.BufferOverrun" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">BufferOverrun</span></code></td></tr><tr id="type-debug_kind.Capture" class="anchored"><td class="def constructor"><a href="#type-debug_kind.Capture" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Capture</span></code></td></tr><tr id="type-debug_kind.Linters" class="anchored"><td class="def constructor"><a href="#type-debug_kind.Linters" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Linters</span></code></td></tr><tr id="type-debug_kind.MergeCapture" class="anchored"><td class="def constructor"><a href="#type-debug_kind.MergeCapture" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">MergeCapture</span></code></td></tr><tr id="type-debug_kind.TestDetermi
|
