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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Capnp_address (capnp-rpc-net.Capnp_rpc_net.Capnp_address)</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; Capnp_address</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_net.Capnp_address</span></code></h1><p>Handling of capnp:// URI format addresses. This code is shared between the unix and mirage networks.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Location"><a href="#module-Location" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Location/index.html">Location</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../S/module-type-ADDRESS/index.html">S.ADDRESS</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../S/module-type-ADDRESS/index.html#type-t">t</a> = <a href="Location/index.html#type-t">Location.t</a> * <a href="../Auth/Digest/index.html#type-t">Auth.Digest.t</a></span></span></code></summary><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><span> = <a href="Location/index.html#type-t">Location.t</a> * <a href="../Auth/Digest/index.html#type-t">Auth.Digest.t</a></span></code></div><div class="spec-doc"><p>A network address at which a vat can be reached.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_uri"><a href="#val-parse_uri" class="anchor"></a><code><span><span class="keyword">val</span> parse_uri : <span><span class="xref-unresolved">Uri</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="#type-t">t</a> * string, <span>[&gt; <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>parse_uri uri</code> extracts from a URI the network address and service ID.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_uri"><a href="#val-to_uri" class="anchor"></a><code><span><span class="keyword">val</span> to_uri : <span><span>(<a href="#type-t">t</a> * string)</span> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Uri</span>.t</span></code></div><div class="spec-doc"><p><code>to_uri (t, service_id)</code> is a URI that can be parsed back into <code>(t, service_id)</code> by <code>parse_uri</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-digest"><a href="#val-digest" class="anchor"></a><code><span><span class="keyword">val</span> digest : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Auth/Digest/index.html#type-t">Auth.Digest.t</a></span></code></div><div class="spec-doc"><p>How to verify that the correct address has been reached.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-t">t</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div></details></div></div></body></html>