simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-07 18:37:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: fcace775d3

Browse source
This commit is contained in:
c-cube 2025-12-05 15:22:35 +00:00
parent d2e7025b61
commit 4ab41fcc56
23 changed files with 377 additions and 320 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html
View file

@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)</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> &#x00BB; <a href="../index.html">opentelemetry-client-ocurl</a> &#x00BB; Opentelemetry_client_ocurl</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-get_headers"><a href="#val-get_headers" class="anchor"></a><code><span><span class="keyword">val</span> get_headers : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_headers"><a href="#val-set_headers" class="anchor"></a><code><span><span class="keyword">val</span> set_headers : <span><span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Set http headers that are sent on every http query to the collector.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Atomic"><a href="#module-Atomic" class="anchor"></a><code><span><span class="keyword">module</span> Atomic</span><span> = <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html">Opentelemetry_atomic.Atomic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">Config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Configuration for the ocurl backend</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_backend"><a href="#val-create_backend" class="anchor"></a><code><span><span class="keyword">val</span> create_backend :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)</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> &#x00BB; <a href="../index.html">opentelemetry-client-ocurl</a> &#x00BB; Opentelemetry_client_ocurl</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-get_headers"><a href="#val-get_headers" class="anchor"></a><code><span><span class="keyword">val</span> get_headers : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_headers"><a href="#val-set_headers" class="anchor"></a><code><span><span class="keyword">val</span> set_headers : <span><span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Set http headers that are sent on every http query to the collector.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Atomic"><a href="#module-Atomic" class="anchor"></a><code><span><span class="keyword">module</span> Atomic</span><span> = <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html">Opentelemetry_atomic.Atomic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">Config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Configuration for the ocurl backend</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-n_bytes_sent"><a href="#val-n_bytes_sent" class="anchor"></a><code><span><span class="keyword">val</span> n_bytes_sent : <span>unit <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Global counter of bytes sent (or attempted to be sent)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_backend"><a href="#val-create_backend" class="anchor"></a><code><span><span class="keyword">val</span> create_backend :
<span><span class="optlabel">?stop</span>:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>

49
opentelemetry-lwt/Opentelemetry_lwt/Logs/index.html
View file

File diff suppressed because one or more lines are too long

2
opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html
View file

@ -50,7 +50,7 @@
list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?exemplars</span>:<span><a href="../../../opentelemetry/Opentelemetry_proto/Metrics/index.html#type-exemplar">Opentelemetry.Proto.Metrics.exemplar</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?explicit_bounds</span>:<span>float list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?sum</span>:<span>float option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?sum</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">bucket_counts</span>:<span>int64 list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">count</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>

2
opentelemetry/Opentelemetry/Metrics/index.html
View file

@ -48,7 +48,7 @@
list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?exemplars</span>:<span><a href="../../Opentelemetry_proto/Metrics/index.html#type-exemplar">Proto.Metrics.exemplar</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?explicit_bounds</span>:<span>float list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?sum</span>:<span>float option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?sum</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">bucket_counts</span>:<span>int64 list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">count</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>

2
opentelemetry/Opentelemetry/Span_status/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span_status (opentelemetry.Opentelemetry.Span_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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Span_status</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span_status</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> = <a href="../../Opentelemetry_proto/Trace/index.html#type-status">Proto.Trace.status</a></span><span> = </span><span>{</span></code><ol><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span>message : string;</span></code></li><li id="type-t.code" class="def record field anchored"><a href="#type-t.code" class="anchor"></a><code><span>code : <a href="../../Opentelemetry_proto/Trace/index.html#type-status_status_code">Proto.Trace.status_status_code</a>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-code"><a href="#type-code" class="anchor"></a><code><span><span class="keyword">type</span> code</span><span> = <a href="../../Opentelemetry_proto/Trace/index.html#type-status_status_code">Proto.Trace.status_status_code</a></span><span> = </span></code><ol><li id="type-code.Status_code_unset" class="def variant constructor anchored"><a href="#type-code.Status_code_unset" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_unset</span></span></code></li><li id="type-code.Status_code_ok" class="def variant constructor anchored"><a href="#type-code.Status_code_ok" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_ok</span></span></code></li><li id="type-code.Status_code_error" class="def variant constructor anchored"><a href="#type-code.Status_code_error" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_error</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span class="label">message</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">code</span>:<a href="#type-code">code</a> <span class="arrow">&#45;&gt;</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>Span_status (opentelemetry.Opentelemetry.Span_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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Span_status</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span_status</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 class="keyword">private</span> <a href="../../Opentelemetry_proto/Trace/index.html#type-status">Proto.Trace.status</a></span><span> = </span><span>{</span></code><ol><li id="type-t._presence" class="def record field anchored"><a href="#type-t._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></li><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span><span class="keyword">mutable</span> message : string;</span></code></li><li id="type-t.code" class="def record field anchored"><a href="#type-t.code" class="anchor"></a><code><span><span class="keyword">mutable</span> code : <a href="../../Opentelemetry_proto/Trace/index.html#type-status_status_code">Proto.Trace.status_status_code</a>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-code"><a href="#type-code" class="anchor"></a><code><span><span class="keyword">type</span> code</span><span> = <a href="../../Opentelemetry_proto/Trace/index.html#type-status_status_code">Proto.Trace.status_status_code</a></span><span> = </span></code><ol><li id="type-code.Status_code_unset" class="def variant constructor anchored"><a href="#type-code.Status_code_unset" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_unset</span></span></code></li><li id="type-code.Status_code_ok" class="def variant constructor anchored"><a href="#type-code.Status_code_ok" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_ok</span></span></code></li><li id="type-code.Status_code_error" class="def variant constructor anchored"><a href="#type-code.Status_code_error" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_error</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span class="label">message</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">code</span>:<a href="#type-code">code</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>

30
opentelemetry/Opentelemetry_proto/Common/index.html
View file

File diff suppressed because one or more lines are too long

37
opentelemetry/Opentelemetry_proto/Logs/index.html
View file

File diff suppressed because one or more lines are too long

42
opentelemetry/Opentelemetry_proto/Logs_service/index.html
View file

File diff suppressed because one or more lines are too long

303
opentelemetry/Opentelemetry_proto/Metrics/index.html
View file

File diff suppressed because one or more lines are too long

48
opentelemetry/Opentelemetry_proto/Metrics_service/index.html
View file

@ -1,25 +1,43 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics_service (opentelemetry.Opentelemetry_proto.Metrics_service)</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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_proto</a> &#x00BB; Metrics_service</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Metrics_service</span></code></h1><p>Code for metrics_service.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-export_metrics_service_request"><a href="#type-export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_service_request</span><span> = </span><span>{</span></code><ol><li id="type-export_metrics_service_request.resource_metrics" class="def record field anchored"><a href="#type-export_metrics_service_request.resource_metrics" class="anchor"></a><code><span>resource_metrics : <span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-export_metrics_partial_success"><a href="#type-export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_partial_success</span><span> = </span><span>{</span></code><ol><li id="type-export_metrics_partial_success.rejected_data_points" class="def record field anchored"><a href="#type-export_metrics_partial_success.rejected_data_points" class="anchor"></a><code><span>rejected_data_points : int64;</span></code></li><li id="type-export_metrics_partial_success.error_message" class="def record field anchored"><a href="#type-export_metrics_partial_success.error_message" class="anchor"></a><code><span>error_message : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-export_metrics_service_response"><a href="#type-export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_service_response</span><span> = </span><span>{</span></code><ol><li id="type-export_metrics_service_response.partial_success" class="def record field anchored"><a href="#type-export_metrics_service_response.partial_success" class="anchor"></a><code><span>partial_success : <span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</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_export_metrics_service_request"><a href="#val-default_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_request :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics_service (opentelemetry.Opentelemetry_proto.Metrics_service)</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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_proto</a> &#x00BB; Metrics_service</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Metrics_service</span></code></h1><p>Code for metrics_service.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-export_metrics_service_request"><a href="#type-export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_service_request</span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-export_metrics_service_request.resource_metrics" class="def record field anchored"><a href="#type-export_metrics_service_request.resource_metrics" class="anchor"></a><code><span><span class="keyword">mutable</span> resource_metrics : <span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-export_metrics_partial_success"><a href="#type-export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_partial_success</span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-export_metrics_partial_success._presence" class="def record field anchored"><a href="#type-export_metrics_partial_success._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-export_metrics_partial_success.rejected_data_points" class="def record field anchored"><a href="#type-export_metrics_partial_success.rejected_data_points" class="anchor"></a><code><span><span class="keyword">mutable</span> rejected_data_points : int64;</span></code></li><li id="type-export_metrics_partial_success.error_message" class="def record field anchored"><a href="#type-export_metrics_partial_success.error_message" class="anchor"></a><code><span><span class="keyword">mutable</span> error_message : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-export_metrics_service_response"><a href="#type-export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_service_response</span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-export_metrics_service_response.partial_success" class="def record field anchored"><a href="#type-export_metrics_service_response.partial_success" class="anchor"></a><code><span><span class="keyword">mutable</span> partial_success : <span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</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_export_metrics_service_request"><a href="#val-default_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_request :
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_service_request ()</code> is a new empty value for type <code>export_metrics_service_request</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_partial_success"><a href="#val-default_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_partial_success :
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_partial_success ()</code> is a new empty value for type <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_service_response"><a href="#val-default_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_response :
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_service_response ()</code> is a new empty value for type <code>export_metrics_service_response</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_export_metrics_service_request"><a href="#val-make_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_service_request :
<span><span class="optlabel">?resource_metrics</span>:<span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_service_request ()</code> is the default value for type <code>export_metrics_service_request</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_partial_success"><a href="#val-default_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_partial_success :
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_service_request … ()</code> is a builder for type <code>export_metrics_service_request</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-copy_export_metrics_service_request"><a href="#val-copy_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> copy_export_metrics_service_request :
<span><a href="#type-export_metrics_service_request">export_metrics_service_request</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-export_metrics_service_request_set_resource_metrics"><a href="#val-export_metrics_service_request_set_resource_metrics" class="anchor"></a><code><span><span class="keyword">val</span> export_metrics_service_request_set_resource_metrics :
<span><a href="#type-export_metrics_service_request">export_metrics_service_request</a> <span class="arrow">&#45;&gt;</span></span>
<span><span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>set field resource_metrics in export_metrics_service_request</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_partial_success"><a href="#val-make_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_partial_success :
<span><span class="optlabel">?rejected_data_points</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?error_message</span>:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_partial_success ()</code> is the default value for type <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_service_response"><a href="#val-default_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_response :
<span><span class="optlabel">?partial_success</span>:<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_partial_success … ()</code> is a builder for type <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-copy_export_metrics_partial_success"><a href="#val-copy_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> copy_export_metrics_partial_success :
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-export_metrics_partial_success_has_rejected_data_points"><a href="#val-export_metrics_partial_success_has_rejected_data_points" class="anchor"></a><code><span><span class="keyword">val</span> export_metrics_partial_success_has_rejected_data_points :
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
bool</span></code></div><div class="spec-doc"><p>presence of field &quot;rejected_data_points&quot; in <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-export_metrics_partial_success_set_rejected_data_points"><a href="#val-export_metrics_partial_success_set_rejected_data_points" class="anchor"></a><code><span><span class="keyword">val</span> export_metrics_partial_success_set_rejected_data_points :
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
<span>int64 <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>set field rejected_data_points in export_metrics_partial_success</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-export_metrics_partial_success_has_error_message"><a href="#val-export_metrics_partial_success_has_error_message" class="anchor"></a><code><span><span class="keyword">val</span> export_metrics_partial_success_has_error_message :
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
bool</span></code></div><div class="spec-doc"><p>presence of field &quot;error_message&quot; in <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-export_metrics_partial_success_set_error_message"><a href="#val-export_metrics_partial_success_set_error_message" class="anchor"></a><code><span><span class="keyword">val</span> export_metrics_partial_success_set_error_message :
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>set field error_message in export_metrics_partial_success</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_service_response"><a href="#val-make_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_service_response :
<span><span class="optlabel">?partial_success</span>:<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_service_response ()</code> is the default value for type <code>export_metrics_service_response</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_export_metrics_service_request"><a href="#val-make_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_service_request :
<span><span class="label">resource_metrics</span>:<span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_service_request … ()</code> is a builder for type <code>export_metrics_service_request</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_partial_success"><a href="#val-make_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_partial_success :
<span><span class="label">rejected_data_points</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">error_message</span>:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_partial_success … ()</code> is a builder for type <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_service_response"><a href="#val-make_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_service_response :
<span><span class="optlabel">?partial_success</span>:<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_service_response … ()</code> is a builder for type <code>export_metrics_service_response</code></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_export_metrics_service_request"><a href="#val-pp_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_service_request :
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_service_response … ()</code> is a builder for type <code>export_metrics_service_response</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-copy_export_metrics_service_response"><a href="#val-copy_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> copy_export_metrics_service_response :
<span><a href="#type-export_metrics_service_response">export_metrics_service_response</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-export_metrics_service_response_set_partial_success"><a href="#val-export_metrics_service_response_set_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> export_metrics_service_response_set_partial_success :
<span><a href="#type-export_metrics_service_response">export_metrics_service_response</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>set field partial_success in export_metrics_service_response</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_export_metrics_service_request"><a href="#val-pp_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_service_request :
<span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="#type-export_metrics_service_request">export_metrics_service_request</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_export_metrics_service_request v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_export_metrics_partial_success"><a href="#val-pp_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_partial_success :

9
opentelemetry/Opentelemetry_proto/Resource/index.html
View file

@ -1,10 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Resource (opentelemetry.Opentelemetry_proto.Resource)</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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_proto</a> &#x00BB; Resource</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Resource</span></code></h1><p>Code for resource.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-resource"><a href="#type-resource" class="anchor"></a><code><span><span class="keyword">type</span> resource</span><span> = </span><span>{</span></code><ol><li id="type-resource.attributes" class="def record field anchored"><a href="#type-resource.attributes" class="anchor"></a><code><span>attributes : <span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span>;</span></code></li><li id="type-resource.dropped_attributes_count" class="def record field anchored"><a href="#type-resource.dropped_attributes_count" class="anchor"></a><code><span>dropped_attributes_count : int32;</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_resource"><a href="#val-default_resource" class="anchor"></a><code><span><span class="keyword">val</span> default_resource :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Resource (opentelemetry.Opentelemetry_proto.Resource)</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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_proto</a> &#x00BB; Resource</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Resource</span></code></h1><p>Code for resource.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-resource"><a href="#type-resource" class="anchor"></a><code><span><span class="keyword">type</span> resource</span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-resource._presence" class="def record field anchored"><a href="#type-resource._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 1 fields</p><span class="comment-delim">*)</span></div></li><li id="type-resource.attributes" class="def record field anchored"><a href="#type-resource.attributes" class="anchor"></a><code><span><span class="keyword">mutable</span> attributes : <span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span>;</span></code></li><li id="type-resource.dropped_attributes_count" class="def record field anchored"><a href="#type-resource.dropped_attributes_count" class="anchor"></a><code><span><span class="keyword">mutable</span> dropped_attributes_count : int32;</span></code></li><li id="type-resource.entity_refs" class="def record field anchored"><a href="#type-resource.entity_refs" class="anchor"></a><code><span><span class="keyword">mutable</span> entity_refs : <span><a href="../Common/index.html#type-entity_ref">Common.entity_ref</a> 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_resource"><a href="#val-default_resource" class="anchor"></a><code><span><span class="keyword">val</span> default_resource : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>default_resource ()</code> is a new empty value for type <code>resource</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_resource"><a href="#val-make_resource" class="anchor"></a><code><span><span class="keyword">val</span> make_resource :
<span><span class="optlabel">?attributes</span>:<span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?dropped_attributes_count</span>:int32 <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?entity_refs</span>:<span><a href="../Common/index.html#type-entity_ref">Common.entity_ref</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>default_resource ()</code> is the default value for type <code>resource</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_resource"><a href="#val-make_resource" class="anchor"></a><code><span><span class="keyword">val</span> make_resource :
<span><span class="label">attributes</span>:<span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dropped_attributes_count</span>:int32 <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>make_resource … ()</code> is a builder for type <code>resource</code></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_resource"><a href="#val-pp_resource" class="anchor"></a><code><span><span class="keyword">val</span> pp_resource : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_resource 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_resource"><a href="#val-encode_pb_resource" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_resource : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>encode_pb_resource 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_resource"><a href="#val-decode_pb_resource" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_resource : <span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>decode_pb_resource decoder</code> decodes a <code>resource</code> binary value from <code>decoder</code></p></div></div></div></body></html>
<a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>make_resource … ()</code> is a builder for type <code>resource</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-copy_resource"><a href="#val-copy_resource" class="anchor"></a><code><span><span class="keyword">val</span> copy_resource : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-resource">resource</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_set_attributes"><a href="#val-resource_set_attributes" class="anchor"></a><code><span><span class="keyword">val</span> resource_set_attributes : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> <span><span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>set field attributes in resource</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_has_dropped_attributes_count"><a href="#val-resource_has_dropped_attributes_count" class="anchor"></a><code><span><span class="keyword">val</span> resource_has_dropped_attributes_count : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>presence of field &quot;dropped_attributes_count&quot; in <code>resource</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_set_dropped_attributes_count"><a href="#val-resource_set_dropped_attributes_count" class="anchor"></a><code><span><span class="keyword">val</span> resource_set_dropped_attributes_count : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> <span>int32 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>set field dropped_attributes_count in resource</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_set_entity_refs"><a href="#val-resource_set_entity_refs" class="anchor"></a><code><span><span class="keyword">val</span> resource_set_entity_refs : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> <span><span><a href="../Common/index.html#type-entity_ref">Common.entity_ref</a> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>set field entity_refs in resource</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_resource"><a href="#val-pp_resource" class="anchor"></a><code><span><span class="keyword">val</span> pp_resource : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_resource 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_resource"><a href="#val-encode_pb_resource" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_resource : <span><a href="#type-resource">resource</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>encode_pb_resource 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_resource"><a href="#val-decode_pb_resource" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_resource : <span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>decode_pb_resource decoder</code> decodes a <code>resource</code> binary value from <code>decoder</code></p></div></div></div></body></html>

9
opentelemetry/Opentelemetry_proto/Status/index.html
View file

@ -1,12 +1,7 @@
<!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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_proto</a> &#x00BB; 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><span>{</span></code><ol><li id="type-status.code" class="def record field anchored"><a href="#type-status.code" class="anchor"></a><code><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>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>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 :
<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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_proto</a> &#x00BB; 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">&#45;&gt;</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">&#45;&gt;</span></span>
<span><span class="optlabel">?message</span>:bytes <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?details</span>:<span>bytes list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</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><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="label">code</span>:int32 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">message</span>:bytes <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">details</span>:<span>bytes list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</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><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">&#45;&gt;</span></span> <span><a href="#type-status">status</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</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>
<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">&#45;&gt;</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">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>presence of field &quot;code&quot; 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">&#45;&gt;</span></span> <span>int32 <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>presence of field &quot;message&quot; 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">&#45;&gt;</span></span> <span>bytes <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><span>bytes list</span> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-status">status</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</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>

71
opentelemetry/Opentelemetry_proto/Trace/index.html
View file

File diff suppressed because one or more lines are too long

44
opentelemetry/Opentelemetry_proto/Trace_service/index.html
View file

File diff suppressed because one or more lines are too long

2
pbrt/Pbrt/Bitfield/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bitfield (pbrt.Pbrt.Bitfield)</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> &#x00BB; <a href="../../index.html">pbrt</a> &#x00BB; <a href="../index.html">Pbrt</a> &#x00BB; Bitfield</nav><header class="odoc-preamble"><h1>Module <code><span>Pbrt.Bitfield</span></code></h1><p>Bitfield used for presence</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> t</span><span> = <span class="keyword">private</span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_bits"><a href="#val-max_bits" class="anchor"></a><code><span><span class="keyword">val</span> max_bits : int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

2
pbrt/Pbrt/Decoder/index.html
View file

File diff suppressed because one or more lines are too long

3
pbrt/Pbrt/Pp/index.html
View file

@ -10,9 +10,10 @@
<span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Stdlib.Hashtbl.t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_record_field"><a href="#val-pp_record_field" class="anchor"></a><code><span><span class="keyword">val</span> pp_record_field :
<span><span class="optlabel">?absent</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?first</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_record_field label_name fmt field_value</code> formats a record <code>field_value</code> with <code>label_name</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_brk"><a href="#val-pp_brk" class="anchor"></a><code><span><span class="keyword">val</span> pp_brk : <span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_brk fmt r</code> formats record value <code>r</code> with curly brakets.</p></div></div></div></body></html>
unit</span></code></div><div class="spec-doc"><p><code>pp_record_field label_name fmt field_value</code> formats a record <code>field_value</code> with <code>label_name</code></p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">absent</span> <p>if true, a comment <code>&quot;(* absent *)&quot;</code> is emitted. since NEXT_RELEASE</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_brk"><a href="#val-pp_brk" class="anchor"></a><code><span><span class="keyword">val</span> pp_brk : <span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-formatter">formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_brk fmt r</code> formats record value <code>r</code> with curly brakets.</p></div></div></div></body></html>

2
pbrt/Pbrt/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pbrt (pbrt.Pbrt)</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> &#x00BB; <a href="../index.html">pbrt</a> &#x00BB; Pbrt</nav><header class="odoc-preamble"><h1>Module <code><span>Pbrt</span></code></h1><p>Protobuf runtime library</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-payload_kind"><a href="#type-payload_kind" class="anchor"></a><code><span><span class="keyword">type</span> payload_kind</span><span> = </span></code><ol><li id="type-payload_kind.Varint" class="def variant constructor anchored"><a href="#type-payload_kind.Varint" class="anchor"></a><code><span>| </span><span><span class="constructor">Varint</span></span></code></li><li id="type-payload_kind.Bits32" class="def variant constructor anchored"><a href="#type-payload_kind.Bits32" class="anchor"></a><code><span>| </span><span><span class="constructor">Bits32</span></span></code></li><li id="type-payload_kind.Bits64" class="def variant constructor anchored"><a href="#type-payload_kind.Bits64" class="anchor"></a><code><span>| </span><span><span class="constructor">Bits64</span></span></code></li><li id="type-payload_kind.Bytes" class="def variant constructor anchored"><a href="#type-payload_kind.Bytes" class="anchor"></a><code><span>| </span><span><span class="constructor">Bytes</span></span></code></li></ol></div><div class="spec-doc"><p>Type of payload in a given field.</p><p>This is only the wire type, the generated code will have a more precise type in general.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Decoder"><a href="#module-Decoder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Decoder/index.html">Decoder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Decoding protobufs.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Encoder"><a href="#module-Encoder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Encoder/index.html">Encoder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Encoding protobufs.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-List_util"><a href="#module-List_util" class="anchor"></a><code><span><span class="keyword">module</span> <a href="List_util/index.html">List_util</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Repeated_field"><a href="#module-Repeated_field" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Repeated_field/index.html">Repeated_field</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Optimized representation for repeated fields</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Pp"><a href="#module-Pp" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Pp/index.html">Pp</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Runtime functions for Pretty Printing functionality</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pbrt (pbrt.Pbrt)</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> &#x00BB; <a href="../index.html">pbrt</a> &#x00BB; Pbrt</nav><header class="odoc-preamble"><h1>Module <code><span>Pbrt</span></code></h1><p>Protobuf runtime library</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-payload_kind"><a href="#type-payload_kind" class="anchor"></a><code><span><span class="keyword">type</span> payload_kind</span><span> = </span></code><ol><li id="type-payload_kind.Varint" class="def variant constructor anchored"><a href="#type-payload_kind.Varint" class="anchor"></a><code><span>| </span><span><span class="constructor">Varint</span></span></code></li><li id="type-payload_kind.Bits32" class="def variant constructor anchored"><a href="#type-payload_kind.Bits32" class="anchor"></a><code><span>| </span><span><span class="constructor">Bits32</span></span></code></li><li id="type-payload_kind.Bits64" class="def variant constructor anchored"><a href="#type-payload_kind.Bits64" class="anchor"></a><code><span>| </span><span><span class="constructor">Bits64</span></span></code></li><li id="type-payload_kind.Bytes" class="def variant constructor anchored"><a href="#type-payload_kind.Bytes" class="anchor"></a><code><span>| </span><span><span class="constructor">Bytes</span></span></code></li></ol></div><div class="spec-doc"><p>Type of payload in a given field.</p><p>This is only the wire type, the generated code will have a more precise type in general.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Decoder"><a href="#module-Decoder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Decoder/index.html">Decoder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Decoding protobufs.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Bitfield"><a href="#module-Bitfield" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Bitfield/index.html">Bitfield</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Bitfield used for presence</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Encoder"><a href="#module-Encoder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Encoder/index.html">Encoder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Encoding protobufs.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-List_util"><a href="#module-List_util" class="anchor"></a><code><span><span class="keyword">module</span> <a href="List_util/index.html">List_util</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Repeated_field"><a href="#module-Repeated_field" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Repeated_field/index.html">Repeated_field</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Optimized representation for repeated fields</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Pp"><a href="#module-Pp" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Pp/index.html">Pp</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Runtime functions for Pretty Printing functionality</p></div></div></div></body></html>

2
pbrt/Pbrt_options/E/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>E (pbrt.Pbrt_options.E)</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> &#x00BB; <a href="../../index.html">pbrt</a> &#x00BB; <a href="../index.html">Pbrt_options</a> &#x00BB; E</nav><header class="odoc-preamble"><h1>Module <code><span>Pbrt_options.E</span></code></h1><p>All exceptions which could be raised by the generated option parsers.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> error</span><span> = </span></code><ol><li id="type-error.Unexpected_option_type" class="def variant constructor anchored"><a href="#type-error.Unexpected_option_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Unexpected_option_type</span> <span class="keyword">of</span> string * string</span></code></li><li id="type-error.Malformed_variant" class="def variant constructor anchored"><a href="#type-error.Malformed_variant" class="anchor"></a><code><span>| </span><span><span class="constructor">Malformed_variant</span> <span class="keyword">of</span> string</span></code></li></ol></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Failure"><a href="#exception-Failure" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Failure</span> <span class="keyword">of</span> <a href="#type-error">error</a></span></code></div><div class="spec-doc"><p>Decoding/Encoding failure</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unexpected_option_type"><a href="#val-unexpected_option_type" class="anchor"></a><code><span><span class="keyword">val</span> unexpected_option_type : <span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>unexpected_option_type record_name field_name</code> raises <code>Failure (Unexpected_json_type (record_name, field_name))</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-malformed_variant"><a href="#val-malformed_variant" class="anchor"></a><code><span><span class="keyword">val</span> malformed_variant : <span>string <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>malformed_variant variant_name</code> raise <code>Failure (Malformed_variant variant_name)</code></p></div></div></div></body></html>

2
pbrt/Pbrt_options/index.html Normal file
View file

File diff suppressed because one or more lines are too long

17
pbrt/_doc-dir/CHANGES.md
View file

@ -1,4 +1,21 @@
## 4.0
- better parsing of protobuf options
- generation of validation code with `--pp_options`
- feat: add `--encode-only` and `--decode-only` features
- take presence semantics in account, to be closer to compliance
with the official protobuf docs and implementation
* use a bitfield to track presence for scalar fields
* use options in more places
* do not serialize non-present fields, to save space
* always generate `make` builders, setters, presence checks
- merge mutable and immutable types, only generate a single record per
message type
- feat codegen: use polyvariants for very large sum types
- fix parser: handle `reserved` in enums
- improved tests
## 3.1.1
- fix error in codegen for nested `oneof` in yojson

15
pbrt/_doc-dir/README.md
View file

@ -192,13 +192,14 @@ Online documentation [here](https://mransan.github.io/ocaml-protoc/dev/pbrt/Pbrt
| Command line switch | Description | Runtime |
| ------------- | ------------- | ----------|
| | Type definition along with a `default` constructor function to conveniently create values of that type | |
| --make | `make` constructor functions | |
| --binary | Binary encodings | `pbrt` |
| --yojson | JSON encoding using the widely popular [yojson](https://github.com/mjambon/yojson) library | `pbrt_yojson` |
| --bs | BuckleScript encoding using the BuckleScript core binding to JS json library | [bs-ocaml-protoc-json][3] |
| --pp | pretty printing functions based on the Format module. | `pbrt` |
| --services | RPC definitions. | `pbrt_services` |
| | Type definition along with a `default` constructor function to conveniently create values of that type | n/a |
| `--make` | `make` constructor functions | n/a |
| `--binary` | Binary encodings | `pbrt` |
| `--yojson` | JSON encoding using the widely popular [yojson](https://github.com/mjambon/yojson) library | `pbrt_yojson` |
| `--bs` | BuckleScript encoding using the BuckleScript core binding to JS json library | [bs-ocaml-protoc-json][3] |
| `--pp` | pretty printing functions based on the Format module. | `pbrt` |
| `--pp_options` | Option validation. | `pbrt.options` |
| `--services` | RPC definitions. | `pbrt_services` |
[3]:https://www.npmjs.com/package/bs-ocaml-protoc-json

2
pbrt/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (pbrt.index)</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> &#x00BB; pbrt</nav><header class="odoc-preamble"><h1 id="package-pbrt"><a href="#package-pbrt" class="anchor"></a>Package pbrt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Pbrt/index.html"><code>Pbrt</code></a> <span class="synopsis">Protobuf runtime library</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE">LICENSE</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (pbrt.index)</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> &#x00BB; pbrt</nav><header class="odoc-preamble"><h1 id="package-pbrt"><a href="#package-pbrt" class="anchor"></a>Package pbrt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Pbrt/index.html"><code>Pbrt</code></a> <span class="synopsis">Protobuf runtime library</span></li><li><a href="Pbrt_options/index.html"><code>Pbrt_options</code></a> <span class="synopsis">Protobuf</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE">LICENSE</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>