-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
75 changed files
with
1,041 additions
and
200 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>V4 (ipaddr-cstruct.Ipaddr_cstruct.V4)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">ipaddr-cstruct</a> » <a href="../index.html">Ipaddr_cstruct</a> » V4</nav><header class="odoc-preamble"><h1>Module <code><span>Ipaddr_cstruct.V4</span></code></h1><p>Ipv4 address conversions</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct"><a href="#val-of_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <span><span>(<a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_cstruct c</code> parses the first 4 octets of <code>c</code> into an IPv4 address.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct_exn"><a href="#val-of_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct_exn : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a></span></code></div><div class="spec-doc"><p><code>of_cstruct_exn</code> parses the first 4 octets of <code>c</code> into an IPv4 address. Raises <code>Ipaddr</code>.Parse_failure on error.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_cstruct"><a href="#val-to_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> to_cstruct : <span>?allocator:<span>(<span>int <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t)</span> <span class="arrow">-></span></span> <span><a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t</span></code></div><div class="spec-doc"><p><code>to_cstruct ipv4</code> is a cstruct of length 4 encoding <code>ipv4</code>. The cstruct is allocated using <code>allocator</code>. If <code>allocator</code> is not provided, <code>Cstruct.create</code> is used.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_cstruct_exn"><a href="#val-write_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> write_cstruct_exn : <span><a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>write_cstruct_exn ipv4 cs</code> writes 4 bytes into <code>cs</code> representing the <code>ipv4</code> address octets. Raises <a href="../../../ipaddr/Ipaddr/index.html#exception-Parse_error"><code>Ipaddr.Parse_error</code></a> if <code>cs</code> is not at least 4 bytes long.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>V4 (ipaddr-cstruct.Ipaddr_cstruct.V4)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">ipaddr-cstruct</a> » <a href="../index.html">Ipaddr_cstruct</a> » V4</nav><header class="odoc-preamble"><h1>Module <code><span>Ipaddr_cstruct.V4</span></code></h1><p>Ipv4 address conversions</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct"><a href="#val-of_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <span><span>(<a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_cstruct c</code> parses the first 4 octets of <code>c</code> into an IPv4 address.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct_exn"><a href="#val-of_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct_exn : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a></span></code></div><div class="spec-doc"><p><code>of_cstruct_exn</code> parses the first 4 octets of <code>c</code> into an IPv4 address. Raises <code>Ipaddr.Parse_failure</code> on error.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_cstruct"><a href="#val-to_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> to_cstruct : <span><span class="optlabel">?allocator</span>:<span>(<span>int <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t)</span> <span class="arrow">-></span></span> <span><a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t</span></code></div><div class="spec-doc"><p><code>to_cstruct ipv4</code> is a cstruct of length 4 encoding <code>ipv4</code>. The cstruct is allocated using <code>allocator</code>. If <code>allocator</code> is not provided, <code>Cstruct.create</code> is used.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_cstruct_exn"><a href="#val-write_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> write_cstruct_exn : <span><a href="../../../ipaddr/Ipaddr/V4/index.html#type-t">Ipaddr.V4.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>write_cstruct_exn ipv4 cs</code> writes 4 bytes into <code>cs</code> representing the <code>ipv4</code> address octets. Raises <a href="../../../ipaddr/Ipaddr/index.html#exception-Parse_error"><code>Ipaddr.Parse_error</code></a> if <code>cs</code> is not at least 4 bytes long.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>V6 (ipaddr-cstruct.Ipaddr_cstruct.V6)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">ipaddr-cstruct</a> » <a href="../index.html">Ipaddr_cstruct</a> » V6</nav><header class="odoc-preamble"><h1>Module <code><span>Ipaddr_cstruct.V6</span></code></h1><p>Ipv6 address conversions</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct"><a href="#val-of_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <span><span>(<a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_cstruct c</code> parses the first 16 octets of <code>c</code> into an IPv6 address.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct_exn"><a href="#val-of_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct_exn : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a></span></code></div><div class="spec-doc"><p><code>of_cstruct_exn</code> parses the first 16 octets of <code>c</code> into an IPv6 address. Raises <code>Ipaddr</code>.Parse_failure on error.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_cstruct"><a href="#val-to_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> to_cstruct : <span>?allocator:<span>(<span>int <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t)</span> <span class="arrow">-></span></span> <span><a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t</span></code></div><div class="spec-doc"><p><code>to_cstruct ipv6</code> is a cstruct of length 16 encoding <code>ipv6</code>. The cstruct is allocated using <code>allocator</code>. If <code>allocator</code> is not provided, <code>Cstruct.create</code> is used.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_cstruct_exn"><a href="#val-write_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> write_cstruct_exn : <span><a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>write_cstruct_exn ipv6 cs</code> writes 16 bytes into <code>cs</code> representing the <code>ipv6</code> address octets. Raises <a href="../../../ipaddr/Ipaddr/index.html#exception-Parse_error"><code>Ipaddr.Parse_error</code></a> if <code>cs</code> is not at least 16 bytes long.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>V6 (ipaddr-cstruct.Ipaddr_cstruct.V6)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">ipaddr-cstruct</a> » <a href="../index.html">Ipaddr_cstruct</a> » V6</nav><header class="odoc-preamble"><h1>Module <code><span>Ipaddr_cstruct.V6</span></code></h1><p>Ipv6 address conversions</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct"><a href="#val-of_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <span><span>(<a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_cstruct c</code> parses the first 16 octets of <code>c</code> into an IPv6 address.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_cstruct_exn"><a href="#val-of_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_cstruct_exn : <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> <a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a></span></code></div><div class="spec-doc"><p><code>of_cstruct_exn</code> parses the first 16 octets of <code>c</code> into an IPv6 address. Raises <code>Ipaddr.Parse_failure</code> on error.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_cstruct"><a href="#val-to_cstruct" class="anchor"></a><code><span><span class="keyword">val</span> to_cstruct : <span><span class="optlabel">?allocator</span>:<span>(<span>int <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t)</span> <span class="arrow">-></span></span> <span><a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Cstruct</span>.t</span></code></div><div class="spec-doc"><p><code>to_cstruct ipv6</code> is a cstruct of length 16 encoding <code>ipv6</code>. The cstruct is allocated using <code>allocator</code>. If <code>allocator</code> is not provided, <code>Cstruct.create</code> is used.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_cstruct_exn"><a href="#val-write_cstruct_exn" class="anchor"></a><code><span><span class="keyword">val</span> write_cstruct_exn : <span><a href="../../../ipaddr/Ipaddr/V6/index.html#type-t">Ipaddr.V6.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>write_cstruct_exn ipv6 cs</code> writes 16 bytes into <code>cs</code> representing the <code>ipv6</code> address octets. Raises <a href="../../../ipaddr/Ipaddr/index.html#exception-Parse_error"><code>Ipaddr.Parse_error</code></a> if <code>cs</code> is not at least 16 bytes long.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>Ipaddr_cstruct (ipaddr-cstruct.Ipaddr_cstruct)</title><link rel="stylesheet" href="../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">ipaddr-cstruct</a> » Ipaddr_cstruct</nav><header class="odoc-preamble"><h1>Module <code><span>Ipaddr_cstruct</span></code></h1><p>Convert to and from Cstructs and IP addresses</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-V4"><a href="#module-V4" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V4/index.html">V4</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Ipv4 address conversions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-V6"><a href="#module-V6" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V6/index.html">V6</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Ipv6 address conversions</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ipaddr_cstruct (ipaddr-cstruct.Ipaddr_cstruct)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">ipaddr-cstruct</a> » Ipaddr_cstruct</nav><header class="odoc-preamble"><h1>Module <code><span>Ipaddr_cstruct</span></code></h1><p>Convert to and from Cstructs and IP addresses</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-V4"><a href="#module-V4" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V4/index.html">V4</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Ipv4 address conversions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-V6"><a href="#module-V6" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V6/index.html">V6</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Ipv6 address conversions</p></div></div></div></body></html> |
Oops, something went wrong.