mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-09 12:23:32 -04:00
deploy: 05be245163
This commit is contained in:
c-cube
parent
a20d2feb5d
commit
a3535dfe6c
11 changed files with 12 additions and 111 deletions
|
|
@ -1,5 +1,13 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Argument (trace-fuchsia.Trace_fuchsia_write.Argument)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia_write</a> » Argument</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia_write.Argument</span></code></h1></header><div class="odoc-content"><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> <span>'a t</span></span><span> = string * <span>[< <a href="../index.html#type-user_data">user_data</a> <span><span>| `Kid</span> of int</span> ]</span> <span class="keyword">as</span> 'a</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_valid"><a href="#val-check_valid" class="anchor"></a><code><span><span class="keyword">val</span> check_valid : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_i32_"><a href="#val-is_i32_" class="anchor"></a><code><span><span class="keyword">val</span> is_i32_ : <span>int <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-size_word"><a href="#val-size_word" class="anchor"></a><code><span><span class="keyword">val</span> size_word :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Argument (trace-fuchsia.Trace_fuchsia_write.Argument)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia_write</a> » Argument</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia_write.Argument</span></code></h1></header><div class="odoc-content"><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> <span>'a t</span></span><span> = string * <span>[< <a href="../index.html#type-user_data">user_data</a> <span><span>| `Kid</span> of int</span> ]</span> <span class="keyword">as</span> 'a</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_valid_"><a href="#val-check_valid_" class="anchor"></a><code><span><span class="keyword">val</span> check_valid_ :
|
||||
<span><span><span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span><span>| `Int</span> of int</span>
|
||||
<span><span>| `Kid</span> of int</span>
|
||||
<span>| `None</span>
|
||||
<span><span>| `String</span> of string</span> ]</span>
|
||||
<a href="#type-t">t</a></span> <span class="arrow">-></span></span>
|
||||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_i32_"><a href="#val-is_i32_" class="anchor"></a><code><span><span class="keyword">val</span> is_i32_ : <span>int <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-size_word"><a href="#val-size_word" class="anchor"></a><code><span><span class="keyword">val</span> size_word :
|
||||
<span><span><span>[< <span>`Bool of bool & <span class="type-var">'a</span></span>
|
||||
<span><span>| `Float</span> of float & <span class="type-var">'b</span></span>
|
||||
<span><span>| `Int</span> of int</span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Output (trace-fuchsia.Trace_fuchsia_write.Output)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia_write</a> » Output</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia_write.Output</span></code></h1></header><div class="odoc-content"><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> = </span><span>{</span></code><ol><li id="type-t.buf" class="def record field anchored"><a href="#type-t.buf" class="anchor"></a><code><span><span class="keyword">mutable</span> buf : <a href="../Buf/index.html#type-t">Buf.t</a>;</span></code></li><li id="type-t.send_buf" class="def record field anchored"><a href="#type-t.send_buf" class="anchor"></a><code><span><span class="keyword">mutable</span> send_buf : <span><a href="../Buf/index.html#type-t">Buf.t</a> <span class="arrow">-></span></span> unit;</span></code></li><li id="type-t.buf_pool" class="def record field anchored"><a href="#type-t.buf_pool" class="anchor"></a><code><span>buf_pool : <a href="../Buf_pool/index.html#type-t">Buf_pool.t</a>;</span></code></li></ol><code><span>}</span></code></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>buf_pool:<a href="../Buf_pool/index.html#type-t">Buf_pool.t</a> <span class="arrow">-></span></span> <span>send_buf:<span>(<span><a href="../Buf/index.html#type-t">Buf.t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span><span class="keyword">val</span> flush : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_buf"><a href="#val-get_buf" class="anchor"></a><code><span><span class="keyword">val</span> get_buf : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>available_word:int <span class="arrow">-></span></span> <a href="../Buf/index.html#type-t">Buf.t</a></span></code></div><div class="spec-doc"><p>Obtain a buffer with at least <code>available</code> bytes</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-into_buffer"><a href="#val-into_buffer" class="anchor"></a><code><span><span class="keyword">val</span> into_buffer : <span>buf_pool:<a href="../Buf_pool/index.html#type-t">Buf_pool.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Stdlib</span>.Buffer.t <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dispose"><a href="#val-dispose" class="anchor"></a><code><span><span class="keyword">val</span> dispose : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Output (trace-fuchsia.Trace_fuchsia_write.Output)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia_write</a> » Output</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia_write.Output</span></code></h1></header><div class="odoc-content"><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> = </span><span>{</span></code><ol><li id="type-t.buf" class="def record field anchored"><a href="#type-t.buf" class="anchor"></a><code><span><span class="keyword">mutable</span> buf : <a href="../Buf/index.html#type-t">Buf.t</a>;</span></code></li><li id="type-t.send_buf" class="def record field anchored"><a href="#type-t.send_buf" class="anchor"></a><code><span><span class="keyword">mutable</span> send_buf : <span><a href="../Buf/index.html#type-t">Buf.t</a> <span class="arrow">-></span></span> unit;</span></code></li><li id="type-t.buf_pool" class="def record field anchored"><a href="#type-t.buf_pool" class="anchor"></a><code><span>buf_pool : <a href="../Buf_pool/index.html#type-t">Buf_pool.t</a>;</span></code></li></ol><code><span>}</span></code></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>buf_pool:<a href="../Buf_pool/index.html#type-t">Buf_pool.t</a> <span class="arrow">-></span></span> <span>send_buf:<span>(<span><a href="../Buf/index.html#type-t">Buf.t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span><span class="keyword">val</span> flush : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_size_word"><a href="#val-max_size_word" class="anchor"></a><code><span><span class="keyword">val</span> max_size_word : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Maximum size available, in words, for a single message</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_buf"><a href="#val-get_buf" class="anchor"></a><code><span><span class="keyword">val</span> get_buf : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>available_word:int <span class="arrow">-></span></span> <a href="../Buf/index.html#type-t">Buf.t</a></span></code></div><div class="spec-doc"><p>Obtain a buffer with at least <code>available</code> bytes</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-into_buffer"><a href="#val-into_buffer" class="anchor"></a><code><span><span class="keyword">val</span> into_buffer : <span>buf_pool:<a href="../Buf_pool/index.html#type-t">Buf_pool.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Stdlib</span>.Buffer.t <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dispose"><a href="#val-dispose" class="anchor"></a><code><span><span class="keyword">val</span> dispose : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Str_ref (trace-fuchsia.Trace_fuchsia_write.Str_ref)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia_write</a> » Str_ref</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia_write.Str_ref</span></code></h1></header><div class="odoc-content"><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> = int</span></code></div><div class="spec-doc"><p>16 bits</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-inline"><a href="#val-inline" class="anchor"></a><code><span><span class="keyword">val</span> inline : <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Str_ref (trace-fuchsia.Trace_fuchsia_write.Str_ref)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia_write</a> » Str_ref</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia_write.Str_ref</span></code></h1></header><div class="odoc-content"><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> = int</span></code></div><div class="spec-doc"><p>16 bits</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-inline_fail_"><a href="#val-inline_fail_" class="anchor"></a><code><span><span class="keyword">val</span> inline_fail_ : <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-inline"><a href="#val-inline" class="anchor"></a><code><span><span class="keyword">val</span> inline : <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (trace.Trace_core.Collector)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace</a> » <a href="../index.html">Trace_core</a> » Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_core.Collector</span></code></h1><p>A global collector.</p><p>The collector, if present, is responsible for collecting messages and spans, and storing them, recording them, forward them, or offering them to other services and processes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_span"><a href="#val-dummy_span" class="anchor"></a><code><span><span class="keyword">val</span> dummy_span : int64</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_explicit_span"><a href="#val-dummy_explicit_span" class="anchor"></a><code><span><span class="keyword">val</span> dummy_explicit_span : <span class="xref-unresolved">Trace_core__.Types.explicit_span</span></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature for a collector.</p></div></div></div></body></html>
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (trace.Trace_core.Collector.S)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace</a> » <a href="../../index.html">Trace_core</a> » <a href="../index.html">Collector</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.S</span></code></h1><p>Signature for a collector.</p><p>This is only relevant to implementors of tracing backends; to instrument your code you only need to look at the <a href="../../../Trace/index.html"><code>Trace</code></a> module.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-with_span"><a href="#val-with_span" class="anchor"></a><code><span><span class="keyword">val</span> with_span :
|
||||
<span>__FUNCTION__:<span>string option</span> <span class="arrow">-></span></span>
|
||||
<span>__FILE__:string <span class="arrow">-></span></span>
|
||||
<span>__LINE__:int <span class="arrow">-></span></span>
|
||||
<span>data:
|
||||
<span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span>(<span>int64 <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Run the function in a new span.</p><p>This replaces the previous <code>enter_span</code> and <code>exit_span</code> which were too flexible to be efficient to implement in async contexts.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enter_span"><a href="#val-enter_span" class="anchor"></a><code><span><span class="keyword">val</span> enter_span :
|
||||
<span>__FUNCTION__:<span>string option</span> <span class="arrow">-></span></span>
|
||||
<span>__FILE__:string <span class="arrow">-></span></span>
|
||||
<span>__LINE__:int <span class="arrow">-></span></span>
|
||||
<span>data:
|
||||
<span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
int64</span></code></div><div class="spec-doc"><p>Enter a new implicit span. For many uses cases, <a href="#val-with_span"><code>with_span</code></a> will be easier to use.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exit_span"><a href="#val-exit_span" class="anchor"></a><code><span><span class="keyword">val</span> exit_span : <span>int64 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Exit span. This should be called on the same thread as the corresponding <a href="#val-enter_span"><code>enter_span</code></a>, and nest properly with other calls to enter/exit_span and <a href="#val-with_span"><code>with_span</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enter_manual_span"><a href="#val-enter_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> enter_manual_span :
|
||||
<span>parent:<span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> option</span> <span class="arrow">-></span></span>
|
||||
<span>flavor:<span><span>[ `Sync <span>| `Async</span> ]</span> option</span> <span class="arrow">-></span></span>
|
||||
<span>__FUNCTION__:<span>string option</span> <span class="arrow">-></span></span>
|
||||
<span>__FILE__:string <span class="arrow">-></span></span>
|
||||
<span>__LINE__:int <span class="arrow">-></span></span>
|
||||
<span>data:
|
||||
<span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span class="xref-unresolved">Trace_core__.Types.explicit_span</span></span></code></div><div class="spec-doc"><p>Enter an explicit span. Surrounding scope, if any, is provided by <code>parent</code>, and this function can store as much metadata as it wants in the hmap in the <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a>'s <code>meta</code> field.</p><p>This means that the collector doesn't need to implement contextual storage mapping <a href="../../index.html#type-explicit_span.span"><code>span</code></a> to scopes, metadata, etc. on its side; everything can be transmitted in the <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exit_manual_span"><a href="#val-exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> exit_manual_span : <span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Exit an explicit span.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_data_to_span"><a href="#val-add_data_to_span" class="anchor"></a><code><span><span class="keyword">val</span> add_data_to_span :
|
||||
<span>int64 <span class="arrow">-></span></span>
|
||||
<span><span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> Adds data to the current span.</li></ul><p>0.4</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_data_to_manual_span"><a href="#val-add_data_to_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> add_data_to_manual_span :
|
||||
<span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> <span class="arrow">-></span></span>
|
||||
<span><span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>Adds data to the given span.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-message"><a href="#val-message" class="anchor"></a><code><span><span class="keyword">val</span> message :
|
||||
<span>?span:int64 <span class="arrow">-></span></span>
|
||||
<span>data:
|
||||
<span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>Emit a message with associated metadata.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name_thread"><a href="#val-name_thread" class="anchor"></a><code><span><span class="keyword">val</span> name_thread : <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Give a name to the current thread.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name_process"><a href="#val-name_process" class="anchor"></a><code><span><span class="keyword">val</span> name_process : <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Give a name to the current process.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-counter_int"><a href="#val-counter_int" class="anchor"></a><code><span><span class="keyword">val</span> counter_int :
|
||||
<span>data:
|
||||
<span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span>int <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>Integer counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-counter_float"><a href="#val-counter_float" class="anchor"></a><code><span><span class="keyword">val</span> counter_float :
|
||||
<span>data:
|
||||
<span><span>(string
|
||||
* <span>[ <span>`Int of int</span>
|
||||
<span><span>| `String</span> of string</span>
|
||||
<span><span>| `Bool</span> of bool</span>
|
||||
<span><span>| `Float</span> of float</span>
|
||||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span>float <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>Float counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown"><a href="#val-shutdown" class="anchor"></a><code><span><span class="keyword">val</span> shutdown : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Shutdown collector, possibly waiting for it to finish sending data.</p></div></div></div></body></html>
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (trace.Trace_core.Meta_map.Key)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace</a> » <a href="../../index.html">Trace_core</a> » <a href="../index.html">Meta_map</a> » Key</nav><header class="odoc-preamble"><h1>Module <code><span>Meta_map.Key</span></code></h1><p>Keys with a type witness.</p></header><div class="odoc-content"><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> <span>'a t</span></span></code></div><div class="spec-doc"><p>A key of type <code>'a t</code> is used to access the portion of the map or table that associates keys of type <code>'a</code> to values.</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>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Make a new key. This is generative, so calling <code>create ()</code> twice with the same return type will produce incompatible keys that cannot see each other's bindings.</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><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Compare two keys that have compatible types.</p></div></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B_queue (trace.Trace_private_util.B_queue)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace</a> » <a href="../index.html">Trace_private_util</a> » B_queue</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util.B_queue</span></code></h1><p>Basic Blocking Queue</p></header><div class="odoc-content"><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> <span>'a t</span></span></code></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>unit <span class="arrow">-></span></span> <span><span class="type-var">_</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Closed"><a href="#exception-Closed" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Closed</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-push"><a href="#val-push" class="anchor"></a><code><span><span class="keyword">val</span> push : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>push q x</code> pushes <code>x</code> into <code>q</code>, and returns <code>()</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Closed</span> <p>if <code>close q</code> was previously called.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pop_all"><a href="#val-pop_all" class="anchor"></a><code><span><span class="keyword">val</span> pop_all : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> list</span></span></code></div><div class="spec-doc"><p><code>pop_all bq</code> returns all items presently in <code>bq</code>, in the same order, and clears <code>bq</code>. It blocks if no element is in <code>bq</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><span><span class="type-var">_</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Close the queue, meaning there won't be any more <code>push</code> allowed.</p></div></div></div></body></html>
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Domain_util (trace.Trace_private_util.Domain_util)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace</a> » <a href="../index.html">Trace_private_util</a> » Domain_util</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util.Domain_util</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-cpu_relax"><a href="#val-cpu_relax" class="anchor"></a><code><span><span class="keyword">val</span> cpu_relax : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-n_domains"><a href="#val-n_domains" class="anchor"></a><code><span><span class="keyword">val</span> n_domains : <span>unit <span class="arrow">-></span></span> int</span></code></div></div></div></body></html>
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mpsc_bag (trace.Trace_private_util.Mpsc_bag)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">trace</a> » <a href="../index.html">Trace_private_util</a> » Mpsc_bag</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util.Mpsc_bag</span></code></h1><p>A multi-producer, single-consumer bag</p></header><div class="odoc-content"><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> <span>'a t</span></span></code></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>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>add q x</code> adds <code>x</code> in the bag.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pop_all"><a href="#val-pop_all" class="anchor"></a><code><span><span class="keyword">val</span> pop_all : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> list</span> option</span></span></code></div><div class="spec-doc"><p>Return all current items in the insertion order.</p></div></div></div></body></html>
|
||||
Loading…
Add table
Reference in a new issue