man-pages/man3/Obj.Ephemeron.3o.html
2021-03-31 01:06:50 +01:00

281 lines
3.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Obj.Ephemeron</TITLE>
</HEAD><BODY>
<H1>Obj.Ephemeron</H1>
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Obj.Ephemeron - no description
<A NAME="lbAC">&nbsp;</A>
<H2>Module</H2>
Module Obj.Ephemeron
<A NAME="lbAD">&nbsp;</A>
<H2>Documentation</H2>
<P>
Module
<B>Ephemeron</B>
<BR>&nbsp;:&nbsp;
<B>sig end</B>
<P>
<P>
<P>
<P>
<P>
<P>
<P>
<P>
<P>
Ephemeron with arbitrary arity and untyped
<P>
<I>type obj_t </I>
=
<B>Obj.t</B>
<P>
<P>
alias for
<B>Obj.t</B>
<P>
<P>
<P>
<I>type t </I>
<P>
<P>
an ephemeron cf
<B>Ephemeron</B>
<P>
<P>
<P>
<P>
<I>val create </I>
:
<B>int -&gt; t</B>
<P>
<P>
<B>create n</B>
returns an ephemeron with
<B>n</B>
keys.
All the keys and the data are initially empty.
The argument
<B>n</B>
must be between zero
and
<B>Obj.Ephemeron.max_ephe_length</B>
(limits included).
<P>
<P>
<P>
<I>val length </I>
:
<B>t -&gt; int</B>
<P>
return the number of keys
<P>
<P>
<P>
<I>val get_key </I>
:
<B>t -&gt; int -&gt; obj_t option</B>
<P>
Same as
<B>Ephemeron.K1.get_key</B>
<P>
<P>
<P>
<P>
<I>val get_key_copy </I>
:
<B>t -&gt; int -&gt; obj_t option</B>
<P>
Same as
<B>Ephemeron.K1.get_key_copy</B>
<P>
<P>
<P>
<P>
<I>val set_key </I>
:
<B>t -&gt; int -&gt; obj_t -&gt; unit</B>
<P>
Same as
<B>Ephemeron.K1.set_key</B>
<P>
<P>
<P>
<P>
<I>val unset_key </I>
:
<B>t -&gt; int -&gt; unit</B>
<P>
Same as
<B>Ephemeron.K1.unset_key</B>
<P>
<P>
<P>
<P>
<I>val check_key </I>
:
<B>t -&gt; int -&gt; bool</B>
<P>
Same as
<B>Ephemeron.K1.check_key</B>
<P>
<P>
<P>
<P>
<I>val blit_key </I>
:
<B>t -&gt; int -&gt; t -&gt; int -&gt; int -&gt; unit</B>
<P>
Same as
<B>Ephemeron.K1.blit_key</B>
<P>
<P>
<P>
<P>
<I>val get_data </I>
:
<B>t -&gt; obj_t option</B>
<P>
Same as
<B>Ephemeron.K1.get_data</B>
<P>
<P>
<P>
<P>
<I>val get_data_copy </I>
:
<B>t -&gt; obj_t option</B>
<P>
Same as
<B>Ephemeron.K1.get_data_copy</B>
<P>
<P>
<P>
<P>
<I>val set_data </I>
:
<B>t -&gt; obj_t -&gt; unit</B>
<P>
Same as
<B>Ephemeron.K1.set_data</B>
<P>
<P>
<P>
<P>
<I>val unset_data </I>
:
<B>t -&gt; unit</B>
<P>
Same as
<B>Ephemeron.K1.unset_data</B>
<P>
<P>
<P>
<P>
<I>val check_data </I>
:
<B>t -&gt; bool</B>
<P>
Same as
<B>Ephemeron.K1.check_data</B>
<P>
<P>
<P>
<P>
<I>val blit_data </I>
:
<B>t -&gt; t -&gt; unit</B>
<P>
Same as
<B>Ephemeron.K1.blit_data</B>
<P>
<P>
<P>
<P>
<I>val max_ephe_length </I>
:
<B>int</B>
<P>
Maximum length of an ephemeron, ie the maximum number of keys an
ephemeron could contain
<P>
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">Module</A><DD>
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:49 GMT, March 31, 2021
</BODY>
</HTML>