tiny_httpd/hmap/Hmap/Key/index.html
2024-03-07 02:28:50 +00:00

2 lines
3.1 KiB
HTML
Raw 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>Key (hmap.Hmap.Key)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../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">hmap</a> &#x00BB; <a href="../index.html">Hmap</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>Hmap.Key</span></code></h1><p>Keys.</p></header><nav class="odoc-toc"><ul><li><a href="#keys">Keys</a></li><li><a href="#exists">Existential keys</a></li></ul></nav><div class="odoc-content"><h2 id="keys"><a href="#keys" class="anchor"></a>Keys</h2><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>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span></span></code></div><div class="spec-doc"><p><code>create ()</code> is a new key.</p></div></div><h2 id="exists"><a href="#exists" class="anchor"></a>Existential keys</h2><p>Exisential keys allows to compare keys. This can be useful for functions like <a href="../index.html#val-filter"><code>filter</code></a>.</p><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>The type for existential keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hide_type"><a href="#val-hide_type" class="anchor"></a><code><span><span class="keyword">val</span> hide_type : <span><span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>hide_type k</code> is an existential key for <code>k</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 class="spec-doc"><p><code>equal k k'</code> is <code>true</code> iff <code>k</code> and <code>k'</code> are the same key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <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> int</span></code></div><div class="spec-doc"><p><code>compare k k'</code> is a total order on keys compatible with <a href="#val-equal"><code>equal</code></a>.</p></div></div></div></body></html>