ocaml-rpc/capnp-rpc/Capnp_rpc/Message/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Message (capnp-rpc.Capnp_rpc.Message)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">capnp-rpc</a> &#x00BB; <a href="../index.html">Capnp_rpc</a> &#x00BB; Message</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc.Message</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-storage_t"><a href="#type-storage_t" class="anchor"></a><code><span><span class="keyword">type</span> storage_t</span><span> = <span class="xref-unresolved">Stdlib</span>.Bytes.t</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-storage_descr_t"><a href="#type-storage_descr_t" class="anchor"></a><code><span><span class="keyword">type</span> storage_descr_t</span><span> = <span class="xref-unresolved">Capnp__Message</span>.BytesMessage.Message.storage_descr_t</span><span> = </span><span>{</span></code><ol><li id="type-storage_descr_t.segment" class="def record field anchored"><a href="#type-storage_descr_t.segment" class="anchor"></a><code><span>segment : <a href="#type-storage_t">storage_t</a>;</span></code></li><li id="type-storage_descr_t.bytes_consumed" class="def record field anchored"><a href="#type-storage_descr_t.bytes_consumed" class="anchor"></a><code><span>bytes_consumed : int;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'cap t</span></span><span> = <span><span class="type-var">'cap</span> <span class="xref-unresolved">Capnp__Message</span>.BytesMessage.Message.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-release"><a href="#val-release" class="anchor"></a><code><span><span class="keyword">val</span> release : <span><span><span class="type-var">'cap</span> <a href="#type-t">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-num_segments"><a href="#val-num_segments" class="anchor"></a><code><span><span class="keyword">val</span> num_segments : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-total_size"><a href="#val-total_size" class="anchor"></a><code><span><span class="keyword">val</span> total_size : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-total_alloc_size"><a href="#val-total_alloc_size" class="anchor"></a><code><span><span class="keyword">val</span> total_alloc_size : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_segment"><a href="#val-get_segment" class="anchor"></a><code><span><span class="keyword">val</span> get_segment : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'cap</span> <a href="../Segment/index.html#type-t">Segment.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-readonly"><a href="#val-readonly" class="anchor"></a><code><span><span class="keyword">val</span> readonly : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Capnp__MessageSig</span>.ro <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_storage"><a href="#val-of_storage" class="anchor"></a><code><span><span class="keyword">val</span> of_storage : <span><span><a href="#type-storage_t">storage_t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_storage"><a href="#val-to_storage" class="anchor"></a><code><span><span class="keyword">val</span> to_storage : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-storage_descr_t">storage_descr_t</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_message"><a href="#val-with_message" class="anchor"></a><code><span><span class="keyword">val</span> with_message : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">f</span>:<span>(<span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_attachments"><a href="#val-with_attachments" class="anchor"></a><code><span><span class="keyword">val</span> with_attachments : <span><span class="xref-unresolved">Capnp__MessageSig</span>.attachments <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'cap</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_attachments"><a href="#val-get_attachments" class="anchor"></a><code><span><span class="keyword">val</span> get_attachments : <span><span><span class="type-var">'cap</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Capnp__MessageSig</span>.attachments</span></code></div></div></div></body></html>