ocaml-rpc/capnp-rpc-net/Capnp_rpc_net/Restorer/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Restorer (capnp-rpc-net.Capnp_rpc_net.Restorer)</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-net</a> &#x00BB; <a href="../index.html">Capnp_rpc_net</a> &#x00BB; Restorer</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_net.Restorer</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#resolutions">Resolutions</a></li><li><a href="#restorers">Restorers</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Id"><a href="#module-Id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Id/index.html">Id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h3 id="resolutions"><a href="#resolutions" class="anchor"></a>Resolutions</h3><div class="odoc-spec"><div class="spec type anchored" id="type-resolution"><a href="#type-resolution" class="anchor"></a><code><span><span class="keyword">type</span> resolution</span></code></div><div class="spec-doc"><p>Internally, this is just <code>('a Capability.t, Capnp_rpc.Exception.t) result</code> but the types work out better having it abstract.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-grant"><a href="#val-grant" class="anchor"></a><code><span><span class="keyword">val</span> grant : <span><span><span class="type-var">'a</span> <a href="../../../capnp-rpc/Capnp_rpc/Capability/index.html#type-t">Capnp_rpc.Std.Capability.t</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-resolution">resolution</a></span></code></div><div class="spec-doc"><p><code>grant x</code> is <code>Ok x</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reject"><a href="#val-reject" class="anchor"></a><code><span><span class="keyword">val</span> reject : <span><a href="../../../capnp-rpc/Capnp_rpc_proto/Exception/index.html#type-t">Capnp_rpc.Exception.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-resolution">resolution</a></span></code></div><div class="spec-doc"><p><code>reject x</code> is <code>Error x</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unknown_service_id"><a href="#val-unknown_service_id" class="anchor"></a><code><span><span class="keyword">val</span> unknown_service_id : <a href="#type-resolution">resolution</a></span></code></div><div class="spec-doc"><p><code>unknown_service_id</code> is a standard rejection message.</p></div></div><h3 id="restorers"><a href="#restorers" class="anchor"></a>Restorers</h3><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></code></div><div class="spec-doc"><p>A restorer looks up live capabilities from service IDs.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-none"><a href="#val-none" class="anchor"></a><code><span><span class="keyword">val</span> none : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>none</code> is a restorer that rejects everything.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-single"><a href="#val-single" class="anchor"></a><code><span><span class="keyword">val</span> single : <span><a href="Id/index.html#type-t">Id.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> <a href="../../../capnp-rpc/Capnp_rpc/Capability/index.html#type-t">Capnp_rpc.Std.Capability.t</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>single id cap</code> is a restorer that responds to <code>id</code> with <code>cap</code> and rejects everything else.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-LOADER"><a href="#module-type-LOADER" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-LOADER/index.html">LOADER</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-Table"><a href="#module-Table" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Table/index.html">Table</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_table"><a href="#val-of_table" class="anchor"></a><code><span><span class="keyword">val</span> of_table : <span><a href="Table/index.html#type-t">Table.t</a> <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-restore"><a href="#val-restore" class="anchor"></a><code><span><span class="keyword">val</span> restore : 
  <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="Id/index.html#type-t">Id.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span>(<span><span class="type-var">'a</span> <a href="../../../capnp-rpc/Capnp_rpc/Capability/index.html#type-t">Capnp_rpc.Std.Capability.t</a></span>, <a href="../../../capnp-rpc/Capnp_rpc_proto/Exception/index.html#type-t">Capnp_rpc.Exception.t</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>restore t id</code> restores <code>id</code> using <code>t</code>. You don't normally need to call this directly, as the Vat will do it automatically.</p></div></div></div></body></html>