Skip to content

Commit

Permalink
Update capnp-rpc doc to 2.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
talex5 committed Nov 30, 2024
1 parent 78a49a0 commit 8b7b781
Show file tree
Hide file tree
Showing 451 changed files with 686 additions and 618 deletions.
2 changes: 1 addition & 1 deletion capnp-rpc-lwt/Capnp_rpc_lwt/Capability/Request/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Request (capnp-rpc-lwt.Capnp_rpc_lwt.Capability.Request)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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-lwt</a> &#x00BB; <a href="../../index.html">Capnp_rpc_lwt</a> &#x00BB; <a href="../index.html">Capability</a> &#x00BB; Request</nav><header class="odoc-preamble"><h1>Module <code><span>Capability.Request</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> <span>'a t</span></span></code></div><div class="spec-doc"><p>An <code>'a t</code> is a builder for the out-going request's payload.</p></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><span class="optlabel">?message_size</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span><span class="xref-unresolved">Capnp</span>.Message.rw <a href="../../Slice/index.html#type-t">Slice.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><span class="type-var">'a</span> <a href="#type-t">t</a></span> * <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>create init</code> is a fresh request payload and contents builder. Use one of the generated <code>init_pointer</code> functions for <code>init</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">message_size</span> <p>An estimate of the size of the payload. If this is too small, additional segments will be allocated automatically, but this is less efficient than getting the size right to start with.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_no_args"><a href="#val-create_no_args" class="anchor"></a><code><span><span class="keyword">val</span> create_no_args : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create_no_args ()</code> is a payload with no content.</p></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">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Clear the exported refs, dropping their ref-counts. This is called automatically when you send a message, but you might need it if you decide to abort.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Request (capnp-rpc-lwt.Capnp_rpc_lwt.Capability.Request)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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-lwt</a> &#x00BB; <a href="../../index.html">Capnp_rpc_lwt</a> &#x00BB; <a href="../index.html">Capability</a> &#x00BB; Request</nav><header class="odoc-preamble"><h1>Module <code><span>Capability.Request</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> <span>'a t</span></span></code></div><div class="spec-doc"><p>An <code>'a t</code> is a builder for the out-going request's payload.</p></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><span class="optlabel">?message_size</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span><span class="xref-unresolved">Capnp</span>.Message.rw <a href="../../../../capnp-rpc/Capnp_rpc/Slice/index.html#type-t">Slice.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><span class="type-var">'a</span> <a href="#type-t">t</a></span> * <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>create init</code> is a fresh request payload and contents builder. Use one of the generated <code>init_pointer</code> functions for <code>init</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">message_size</span> <p>An estimate of the size of the payload. If this is too small, additional segments will be allocated automatically, but this is less efficient than getting the size right to start with.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_no_args"><a href="#val-create_no_args" class="anchor"></a><code><span><span class="keyword">val</span> create_no_args : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create_no_args ()</code> is a payload with no content.</p></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">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Clear the exported refs, dropping their ref-counts. This is called automatically when you send a message, but you might need it if you decide to abort.</p></div></div></div></body></html>
Loading

0 comments on commit 8b7b781

Please sign in to comment.