mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 16:16:48 -05:00
2 lines
No EOL
4.3 KiB
HTML
2 lines
No EOL
4.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>K1 (ocaml.Stdlib.Ephemeron.K1)</title><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">ocaml</a> » <a href="../../index.html">Stdlib</a> » <a href="../index.html">Ephemeron</a> » K1</nav><header class="odoc-preamble"><h1>Module <code><span>Ephemeron.K1</span></code></h1><p>Ephemerons with one key.</p></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>('k, 'd) t</span></span></code></div><div class="spec-doc"><p>an ephemeron with one key</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span class="type-var">'k</span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'k</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>Ephemeron.K1.make k d</code> creates an ephemeron with key <code>k</code> and data <code>d</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-query"><a href="#val-query" class="anchor"></a><code><span><span class="keyword">val</span> query : <span><span><span>(<span class="type-var">'k</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k</span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> option</span></span></code></div><div class="spec-doc"><p><code>Ephemeron.K1.query eph key</code> returns <code>Some x</code> (where <code>x</code> is the ephemeron's data) if <code>key</code> is physically equal to <code>eph</code>'s key, and <code>None</code> if <code>eph</code> is empty or <code>key</code> is not equal to <code>eph</code>'s key.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-H/index.html">H</a> : <a href="../../Hashtbl/module-type-HashedType/index.html">Hashtbl.HashedType</a>) : <a href="../module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../module-type-S/index.html#type-key">key</a> = <a href="Make/argument-1-H/index.html#type-t">H.t</a></span></span></code></div><div class="spec-doc"><p>Functor building an implementation of a weak hash table</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-MakeSeeded"><a href="#module-MakeSeeded" class="anchor"></a><code><span><span class="keyword">module</span> <a href="MakeSeeded/index.html">MakeSeeded</a></span><span> (<a href="MakeSeeded/argument-1-H/index.html">H</a> : <a href="../../Hashtbl/module-type-SeededHashedType/index.html">Hashtbl.SeededHashedType</a>) : <a href="../module-type-SeededS/index.html">SeededS</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../module-type-SeededS/index.html#type-key">key</a> = <a href="MakeSeeded/argument-1-H/index.html#type-t">H.t</a></span></span></code></div><div class="spec-doc"><p>Functor building an implementation of a weak hash table. The seed is similar to the one of <a href="../../Hashtbl/MakeSeeded/index.html"><code>Hashtbl.MakeSeeded</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Bucket"><a href="#module-Bucket" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Bucket/index.html">Bucket</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html> |