mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 04:17:56 -04:00
13 lines
No EOL
4.6 KiB
HTML
13 lines
No EOL
4.6 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Status (opentelemetry.Opentelemetry.Proto.Status)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><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">opentelemetry</a> » <a href="../../index.html">Opentelemetry</a> » <a href="../index.html">Proto</a> » Status</nav><header class="odoc-preamble"><h1>Module <code><span>Proto.Status</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#types">Types</a></li><li><a href="#default-values">Default values</a></li><li><a href="#formatters">Formatters</a></li><li><a href="#protobuf-encoding">Protobuf Encoding</a></li><li><a href="#protobuf-decoding">Protobuf Decoding</a></li></ul></nav><div class="odoc-content"><div class="odoc-include"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type" id="type-status" class="anchored"><a href="#type-status" class="anchor"></a><code><span><span class="keyword">type</span> status</span><span> = </span><span>{</span></code><table><tr id="type-status.code" class="anchored"><td class="def record field"><a href="#type-status.code" class="anchor"></a><code><span>code : int32;</span></code></td></tr><tr id="type-status.message" class="anchored"><td class="def record field"><a href="#type-status.message" class="anchor"></a><code><span>message : bytes;</span></code></td></tr><tr id="type-status.details" class="anchored"><td class="def record field"><a href="#type-status.details" class="anchor"></a><code><span>details : <span>bytes list</span>;</span></code></td></tr></table><code><span>}</span></code></div></div><h3 id="default-values"><a href="#default-values" class="anchor"></a>Default values</h3><div class="odoc-spec"><div class="spec value" id="val-default_status" class="anchored"><a href="#val-default_status" class="anchor"></a><code><span><span class="keyword">val</span> default_status :
|
||
<span>?code:int32 <span class="arrow">-></span></span>
|
||
<span>?message:bytes <span class="arrow">-></span></span>
|
||
<span>?details:<span>bytes list</span> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-status">status</a></span></code></div><div class="spec-doc"><p><code>default_status ()</code> is the default value for type <code>status</code></p></div></div></div><div class="odoc-include"><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value" id="val-pp_status" class="anchored"><a href="#val-pp_status" class="anchor"></a><code><span><span class="keyword">val</span> pp_status :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__Status_types.status</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_status v</code> formats v</p></div></div></div><div class="odoc-include"><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value" id="val-encode_status" class="anchored"><a href="#val-encode_status" class="anchor"></a><code><span><span class="keyword">val</span> encode_status :
|
||
<span><span class="xref-unresolved">Opentelemetry__Status_types.status</span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>encode_status v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><h3 id="protobuf-decoding"><a href="#protobuf-decoding" class="anchor"></a>Protobuf Decoding</h3><div class="odoc-spec"><div class="spec value" id="val-decode_status" class="anchored"><a href="#val-decode_status" class="anchor"></a><code><span><span class="keyword">val</span> decode_status : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">-></span></span> <span class="xref-unresolved">Opentelemetry__Status_types.status</span></span></code></div><div class="spec-doc"><p><code>decode_status decoder</code> decodes a <code>status</code> value from <code>decoder</code></p></div></div></div></div></body></html> |