mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 08:06:43 -05:00
2 lines
No EOL
6.8 KiB
HTML
2 lines
No EOL
6.8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ephemeron (ocaml.Stdlib.Obj.Ephemeron)</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">Obj</a> » Ephemeron</nav><header class="odoc-preamble"><h1>Module <code><span>Obj.Ephemeron</span></code></h1><p>Ephemeron with arbitrary arity and untyped</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-obj_t"><a href="#type-obj_t" class="anchor"></a><code><span><span class="keyword">type</span> obj_t</span><span> = <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p>alias for <a href="../index.html#type-t"><code>Obj.t</code></a></p></div></div><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>an ephemeron cf <a href="#"><code>Ephemeron</code></a></p></div></div><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>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create n</code> returns an ephemeron with <code>n</code> keys. All the keys and the data are initially empty. The argument <code>n</code> must be between zero and <a href="#val-max_ephe_length"><code>max_ephe_length</code></a> (limits included).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-length"><a href="#val-length" class="anchor"></a><code><span><span class="keyword">val</span> length : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>return the number of keys</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key"><a href="#val-get_key" class="anchor"></a><code><span><span class="keyword">val</span> get_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span><a href="#type-obj_t">obj_t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key_copy"><a href="#val-get_key_copy" class="anchor"></a><code><span><span class="keyword">val</span> get_key_copy : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span><a href="#type-obj_t">obj_t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_key"><a href="#val-set_key" class="anchor"></a><code><span><span class="keyword">val</span> set_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span><a href="#type-obj_t">obj_t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unset_key"><a href="#val-unset_key" class="anchor"></a><code><span><span class="keyword">val</span> unset_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_key"><a href="#val-check_key" class="anchor"></a><code><span><span class="keyword">val</span> check_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_key"><a href="#val-blit_key" class="anchor"></a><code><span><span class="keyword">val</span> blit_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_data"><a href="#val-get_data" class="anchor"></a><code><span><span class="keyword">val</span> get_data : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-obj_t">obj_t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_data_copy"><a href="#val-get_data_copy" class="anchor"></a><code><span><span class="keyword">val</span> get_data_copy : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-obj_t">obj_t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_data"><a href="#val-set_data" class="anchor"></a><code><span><span class="keyword">val</span> set_data : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-obj_t">obj_t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unset_data"><a href="#val-unset_data" class="anchor"></a><code><span><span class="keyword">val</span> unset_data : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_data"><a href="#val-check_data" class="anchor"></a><code><span><span class="keyword">val</span> check_data : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_data"><a href="#val-blit_data" class="anchor"></a><code><span><span class="keyword">val</span> blit_data : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_ephe_length"><a href="#val-max_ephe_length" class="anchor"></a><code><span><span class="keyword">val</span> max_ephe_length : int</span></code></div><div class="spec-doc"><p>Maximum length of an ephemeron, ie the maximum number of keys an ephemeron could contain</p></div></div></div></body></html> |