mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
2 lines
No EOL
5.6 KiB
HTML
2 lines
No EOL
5.6 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Containers_cbor (containers.Containers_cbor)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.1"/><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">containers</a> » Containers_cbor</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_cbor</span></code></h1><p>CBOR encoder/decoder.</p><p>The type is chosen to be compatible with ocaml-cbor. See <a href="https://www.rfc-editor.org/rfc/rfc8949.html">the RFC</a>.</p><p><b>note</b> this is experimental.</p><p><b>note</b> this is only available on OCaml >= 4.08. Below that, the module is empty.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.9</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>[ </span></code><table><tr id="type-t.Null" class="anchored"><td class="def constructor"><a href="#type-t.Null" class="anchor"></a><code><span>| </span></code><code><span>`Null</span></code></td></tr><tr id="type-t.Undefined" class="anchored"><td class="def constructor"><a href="#type-t.Undefined" class="anchor"></a><code><span>| </span></code><code><span>`Undefined</span></code></td></tr><tr id="type-t.Simple" class="anchored"><td class="def constructor"><a href="#type-t.Simple" class="anchor"></a><code><span>| </span></code><code><span>`Simple <span class="keyword">of</span> int</span></code></td></tr><tr id="type-t.Bool" class="anchored"><td class="def constructor"><a href="#type-t.Bool" class="anchor"></a><code><span>| </span></code><code><span>`Bool <span class="keyword">of</span> bool</span></code></td></tr><tr id="type-t.Int" class="anchored"><td class="def constructor"><a href="#type-t.Int" class="anchor"></a><code><span>| </span></code><code><span>`Int <span class="keyword">of</span> int</span></code></td></tr><tr id="type-t.Float" class="anchored"><td class="def constructor"><a href="#type-t.Float" class="anchor"></a><code><span>| </span></code><code><span>`Float <span class="keyword">of</span> float</span></code></td></tr><tr id="type-t.Bytes" class="anchored"><td class="def constructor"><a href="#type-t.Bytes" class="anchor"></a><code><span>| </span></code><code><span>`Bytes <span class="keyword">of</span> string</span></code></td></tr><tr id="type-t.Text" class="anchored"><td class="def constructor"><a href="#type-t.Text" class="anchor"></a><code><span>| </span></code><code><span>`Text <span class="keyword">of</span> string</span></code></td></tr><tr id="type-t.Array" class="anchored"><td class="def constructor"><a href="#type-t.Array" class="anchor"></a><code><span>| </span></code><code><span>`Array <span class="keyword">of</span> <span><a href="#type-t">t</a> list</span></span></code></td></tr><tr id="type-t.Map" class="anchored"><td class="def constructor"><a href="#type-t.Map" class="anchor"></a><code><span>| </span></code><code><span>`Map <span class="keyword">of</span> <span><span>(<a href="#type-t">t</a> * <a href="#type-t">t</a>)</span> list</span></span></code></td></tr><tr id="type-t.Tag" class="anchored"><td class="def constructor"><a href="#type-t.Tag" class="anchor"></a><code><span>| </span></code><code><span>`Tag <span class="keyword">of</span> int * <a href="#type-t">t</a></span></code></td></tr></table><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-pp_diagnostic" class="anchored"><a href="#val-pp_diagnostic" class="anchor"></a><code><span><span class="keyword">val</span> pp_diagnostic : <span><a href="#type-t">t</a> <a href="../CCFormat/index.html#type-printer">CCFormat.printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_string_diagnostic" class="anchored"><a href="#val-to_string_diagnostic" class="anchor"></a><code><span><span class="keyword">val</span> to_string_diagnostic : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-encode" class="anchored"><a href="#val-encode" class="anchor"></a><code><span><span class="keyword">val</span> encode : <span>?buf:<span class="xref-unresolved">Stdlib</span>.Buffer.t <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-decode" class="anchored"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode : <span>string <span class="arrow">-></span></span> <span><span>( <a href="#type-t">t</a>, string )</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-decode_exn" class="anchored"><a href="#val-decode_exn" class="anchor"></a><code><span><span class="keyword">val</span> decode_exn : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Like <a href="#val-decode"><code>decode</code></a>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Failure</span> <p>if the string isn't valid</p></li></ul></div></div></div></body></html> |