mirror of
https://github.com/c-cube/linol.git
synced 2025-12-08 12:15:50 -05:00
2 lines
5.7 KiB
HTML
2 lines
5.7 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Src (logs.Logs.Src)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../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">logs</a> » <a href="../index.html">Logs</a> » Src</nav><header class="odoc-preamble"><h1>Module <code><span>Logs.Src</span></code></h1><p>Sources.</p></header><nav class="odoc-toc"><ul><li><a href="#sources">Sources</a></li></ul></nav><div class="odoc-content"><h2 id="sources"><a href="#sources" class="anchor"></a>Sources</h2><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <a href="../index.html#type-src">src</a></span></code></div><div class="spec-doc"><p>The type for log sources.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span class="optlabel">?doc</span>:string <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <a href="../index.html#type-src">src</a></span></code></div><div class="spec-doc"><p><code>create ?doc name</code> is a new log source. <code>name</code> is the name of the source; it doesn't need to be unique but it is good practice to prefix the name with the name of your package or library (e.g. <code>"mypkg.network"</code>). <code>doc</code> is a documentation string describing the source, defaults to <code>"undocumented"</code>. The initial reporting level of the source is defined by <a href="../index.html#type-level"><code>Logs.level</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>name</code> is <code>src</code>'s name.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-doc"><a href="#val-doc" class="anchor"></a><code><span><span class="keyword">val</span> doc : <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>doc src</code> is <code>src</code>'s documentation string.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-level"><a href="#val-level" class="anchor"></a><code><span><span class="keyword">val</span> level : <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-level">level</a> option</span></span></code></div><div class="spec-doc"><p><code>level src</code> is the report level of <code>src</code> (if any).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_level"><a href="#val-set_level" class="anchor"></a><code><span><span class="keyword">val</span> set_level : <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> <span><span><a href="../index.html#type-level">level</a> option</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>set_level src l</code> sets the report level of <code>src</code> to <code>l</code>. Only applications should use this function directly, see <a href="../index.html#usage" title="usage">usage conventions</a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>equal src src'</code> is <code>true</code> iff <code>src</code> and <code>src'</code> are the same source.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>compare src src'</code> is a total order on sources.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-src">src</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>pp ppf src</code> prints an unspecified representation of <code>src</code> on <code>ppf</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-list"><a href="#val-list" class="anchor"></a><code><span><span class="keyword">val</span> list : <span>unit <span class="arrow">-></span></span> <span><a href="../index.html#type-src">src</a> list</span></span></code></div><div class="spec-doc"><p><code>list ()</code> is the current exisiting source list.</p></div></div></div></body></html>
|