zap-proto/ocaml-rpc
2
0
Fork 0
mirror of https://github.com/zap-proto/ocaml-rpc.git synced 2026-11-02 16:33:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
ocaml-rpc/capnp-rpc/Capnp_rpc/Segment/index.html
T

29 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Segment (capnp-rpc.Capnp_rpc.Segment)</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; Segment</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc.Segment</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-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.Segment.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alloc"><a href="#val-alloc" class="anchor"></a><code><span><span class="keyword">val</span> alloc : <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-length"><a href="#val-length" class="anchor"></a><code><span><span class="keyword">val</span> length : <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-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><a href="#type-storage_t">storage_t</a> <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> <a href="#type-storage_t">storage_t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint8"><a href="#val-get_uint8" class="anchor"></a><code><span><span class="keyword">val</span> get_uint8 : <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> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint16"><a href="#val-get_uint16" class="anchor"></a><code><span><span class="keyword">val</span> get_uint16 : <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> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint32"><a href="#val-get_uint32" class="anchor"></a><code><span><span class="keyword">val</span> get_uint32 : <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 class="xref-unresolved">Capnp__MessageSig</span>.Uint32.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint64"><a href="#val-get_uint64" class="anchor"></a><code><span><span class="keyword">val</span> get_uint64 : <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 class="xref-unresolved">Capnp__MessageSig</span>.Uint64.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int8"><a href="#val-get_int8" class="anchor"></a><code><span><span class="keyword">val</span> get_int8 : <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> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int16"><a href="#val-get_int16" class="anchor"></a><code><span><span class="keyword">val</span> get_int16 : <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> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int32"><a href="#val-get_int32" class="anchor"></a><code><span><span class="keyword">val</span> get_int32 : <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 class="xref-unresolved">Stdlib</span>.Int32.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int64"><a href="#val-get_int64" class="anchor"></a><code><span><span class="keyword">val</span> get_int64 : <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 class="xref-unresolved">Stdlib</span>.Int64.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_uint8"><a href="#val-set_uint8" class="anchor"></a><code><span><span class="keyword">val</span> set_uint8 : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_uint16"><a href="#val-set_uint16" class="anchor"></a><code><span><span class="keyword">val</span> set_uint16 : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_uint32"><a href="#val-set_uint32" class="anchor"></a><code><span><span class="keyword">val</span> set_uint32 :
<span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <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="xref-unresolved">Capnp__MessageSig</span>.Uint32.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_uint64"><a href="#val-set_uint64" class="anchor"></a><code><span><span class="keyword">val</span> set_uint64 :
<span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <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="xref-unresolved">Capnp__MessageSig</span>.Uint64.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_int8"><a href="#val-set_int8" class="anchor"></a><code><span><span class="keyword">val</span> set_int8 : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_int16"><a href="#val-set_int16" class="anchor"></a><code><span><span class="keyword">val</span> set_int16 : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_int32"><a href="#val-set_int32" class="anchor"></a><code><span><span class="keyword">val</span> set_int32 : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <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="xref-unresolved">Stdlib</span>.Int32.t <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_int64"><a href="#val-set_int64" class="anchor"></a><code><span><span class="keyword">val</span> set_int64 : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <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="xref-unresolved">Stdlib</span>.Int64.t <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit"><a href="#val-blit" class="anchor"></a><code><span><span class="keyword">val</span> blit :
<span><span class="label">src</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">src_pos</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dst</span>:<span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dst_pos</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">len</span>:int <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_to_bytes"><a href="#val-blit_to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> blit_to_bytes :
<span><span class="label">src</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">src_pos</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dst</span>:<span class="xref-unresolved">Stdlib</span>.Bytes.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dst_pos</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">len</span>:int <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_from_string"><a href="#val-blit_from_string" class="anchor"></a><code><span><span class="keyword">val</span> blit_from_string :
<span><span class="label">src</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">src_pos</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dst</span>:<span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dst_pos</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">len</span>:int <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-zero_out"><a href="#val-zero_out" class="anchor"></a><code><span><span class="keyword">val</span> zero_out : <span><span><span class="xref-unresolved">Capnp__MessageSig</span>.rw <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">pos</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">len</span>:int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink