ocaml-rpc/capnp-rpc/Capnp_rpc_proto/Debug/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Debug (capnp-rpc.Capnp_rpc_proto.Debug)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">capnp-rpc</a> &#x00BB; <a href="../index.html">Capnp_rpc_proto</a> &#x00BB; Debug</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_proto.Debug</span></code></h1><p>Diagnostics.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Log"><a href="#module-Log" class="anchor"></a><code><span><span class="keyword">module</span> Log</span><span> : <span class="xref-unresolved">Logs</span>.LOG</span></code></div><div class="spec-doc"><p>The library's logger.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-src"><a href="#val-src" class="anchor"></a><code><span><span class="keyword">val</span> src : <span class="xref-unresolved">Logs</span>.src</span></code></div><div class="spec-doc"><p>Control the log level for <code>Log</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-qid_tag"><a href="#val-qid_tag" class="anchor"></a><code><span><span class="keyword">val</span> qid_tag : <span><span class="xref-unresolved">Stdint</span>.Uint32.t <span class="xref-unresolved">Logs</span>.Tag.def</span></span></code></div><div class="spec-doc"><p><code>qid_tag</code> is used in log reports to tag the question (or answer) ID in the call.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Invariant_broken"><a href="#exception-Invariant_broken" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Invariant_broken</span> <span class="keyword">of</span> <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_exn"><a href="#val-pp_exn" class="anchor"></a><code><span><span class="keyword">val</span> pp_exn : <span>exn <span class="xref-unresolved">Fmt</span>.t</span></span></code></div><div class="spec-doc"><p><code>pp_exn</code> is like <code>Fmt.exn</code>, but pretty-prints <code>Invariant_broken</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-failf"><a href="#val-failf" class="anchor"></a><code><span><span class="keyword">val</span> failf : <span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Format.formatter, unit, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>failf msg</code> raises <code>Failure msg</code>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Fmt.failwith instead</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-invariant_broken"><a href="#val-invariant_broken" class="anchor"></a><code><span><span class="keyword">val</span> invariant_broken : <span><span>(<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>invariant_broken msg</code> raises <code>Invariant_broken msg</code>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-OID"><a href="#module-OID" class="anchor"></a><code><span><span class="keyword">module</span> <a href="OID/index.html">OID</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unique object IDs, for debugging.</p></div></div></div></body></html>