1Ephemeron.K2.Bucket(3)           OCaml library          Ephemeron.K2.Bucket(3)
2
3
4

NAME

6       Ephemeron.K2.Bucket - no description
7

Module

9       Module   Ephemeron.K2.Bucket
10

Documentation

12       Module Bucket
13        : sig end
14
15
16
17
18
19
20
21       type ('k1, 'k2, 'd) t
22
23
24       A bucket is a mutable "list" of ephemerons.
25
26
27
28       val make : unit -> ('k1, 'k2, 'd) t
29
30       Create a new bucket.
31
32
33
34       val add : ('k1, 'k2, 'd) t -> 'k1 -> 'k2 -> 'd -> unit
35
36       Add an ephemeron to the bucket.
37
38
39
40       val remove : ('k1, 'k2, 'd) t -> 'k1 -> 'k2 -> unit
41
42
43       remove  b  k1  k2 removes from b the most-recently added ephemeron with
44       keys k1 and k2 , or does nothing if there is no such ephemeron.
45
46
47
48       val find : ('k1, 'k2, 'd) t -> 'k1 -> 'k2 -> 'd option
49
50       Returns the data of the most-recently added ephemeron  with  the  given
51       keys, or None if there is no such ephemeron.
52
53
54
55       val length : ('k1, 'k2, 'd) t -> int
56
57       Returns an upper bound on the length of the bucket.
58
59
60
61       val clear : ('k1, 'k2, 'd) t -> unit
62
63       Remove all ephemerons from the bucket.
64
65
66
67
68
69OCamldoc                          2022-07-22            Ephemeron.K2.Bucket(3)