mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-07 18:37:56 -05:00
7 lines
8 KiB
HTML
7 lines
8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Status (opentelemetry.Opentelemetry_proto.Status)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</a> » <a href="../../index.html">opentelemetry</a> » <a href="../index.html">Opentelemetry_proto</a> » Status</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Status</span></code></h1><p>Code for status.proto</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#types">Types</a></li><li><a href="#basic-values">Basic values</a></li><li><a href="#make-functions">Make functions</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><div class="odoc-content"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type anchored" id="type-status"><a href="#type-status" class="anchor"></a><code><span><span class="keyword">type</span> status</span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-status._presence" class="def record field anchored"><a href="#type-status._presence" class="anchor"></a><code><span><span class="keyword">mutable</span> _presence : <a href="../../../pbrt/Pbrt/Bitfield/index.html#type-t">Pbrt.Bitfield.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>presence for 2 fields</p><span class="comment-delim">*)</span></div></li><li id="type-status.code" class="def record field anchored"><a href="#type-status.code" class="anchor"></a><code><span><span class="keyword">mutable</span> code : int32;</span></code></li><li id="type-status.message" class="def record field anchored"><a href="#type-status.message" class="anchor"></a><code><span><span class="keyword">mutable</span> message : bytes;</span></code></li><li id="type-status.details" class="def record field anchored"><a href="#type-status.details" class="anchor"></a><code><span><span class="keyword">mutable</span> details : <span>bytes list</span>;</span></code></li></ol><code><span>}</span></code></div></div><h3 id="basic-values"><a href="#basic-values" class="anchor"></a>Basic values</h3><div class="odoc-spec"><div class="spec value anchored" id="val-default_status"><a href="#val-default_status" class="anchor"></a><code><span><span class="keyword">val</span> default_status : <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 a new empty value for type <code>status</code></p></div></div><h3 id="make-functions"><a href="#make-functions" class="anchor"></a>Make functions</h3><div class="odoc-spec"><div class="spec value anchored" id="val-make_status"><a href="#val-make_status" class="anchor"></a><code><span><span class="keyword">val</span> make_status :
|
||
<span><span class="optlabel">?code</span>:int32 <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?message</span>:bytes <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?details</span>:<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>make_status … ()</code> is a builder for type <code>status</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-copy_status"><a href="#val-copy_status" class="anchor"></a><code><span><span class="keyword">val</span> copy_status : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> <a href="#type-status">status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_has_code"><a href="#val-status_has_code" class="anchor"></a><code><span><span class="keyword">val</span> status_has_code : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>presence of field "code" in <code>status</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_set_code"><a href="#val-status_set_code" class="anchor"></a><code><span><span class="keyword">val</span> status_set_code : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>set field code in status</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_has_message"><a href="#val-status_has_message" class="anchor"></a><code><span><span class="keyword">val</span> status_has_message : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>presence of field "message" in <code>status</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_set_message"><a href="#val-status_set_message" class="anchor"></a><code><span><span class="keyword">val</span> status_set_message : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>set field message in status</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_set_details"><a href="#val-status_set_details" class="anchor"></a><code><span><span class="keyword">val</span> status_set_details : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> <span><span>bytes list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>set field details in status</p></div></div><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value anchored" id="val-pp_status"><a href="#val-pp_status" class="anchor"></a><code><span><span class="keyword">val</span> pp_status : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="#type-status">status</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_status v</code> formats v</p></div></div><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value anchored" id="val-encode_pb_status"><a href="#val-encode_pb_status" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_status : <span><a href="#type-status">status</a> <span class="arrow">-></span></span> <span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>encode_pb_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 anchored" id="val-decode_pb_status"><a href="#val-decode_pb_status" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_status : <span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">-></span></span> <a href="#type-status">status</a></span></code></div><div class="spec-doc"><p><code>decode_pb_status decoder</code> decodes a <code>status</code> binary value from <code>decoder</code></p></div></div></div></body></html>
|