package index

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

include S

type t

The type for indexes.

type key

The type for keys.

type value

The type for values.

val v : ?fresh:bool -> ?readonly:bool -> log_size:int -> string -> t

The constructor for indexes.

val clear : t -> unit

clear t clears t so that there are no more bindings in it.

val find : t -> key -> value

find t k is the binding of k in t.

val mem : t -> key -> bool

mem t k is true iff k is bound in t.

exception Invalid_key_size of key

exception Invalid_value_size of value

The exceptions raised when trying to add a key or a value of different size than encoded_size

val replace : t -> key -> value -> unit

replace t k v binds k to v in t, replacing any existing binding of k.

val iter : (key -> value -> unit) -> t -> unit

Iterates over the index bindings. Limitations:

Order is not specified.
In case of recent replacements of existing values (since the last merge), this will hit both the new and old bindings.
May not observe recent concurrent updates to the index by other processes.

val flush : t -> unit

Flushes all buffers to the supplied IO instance.

val close : t -> unit

Closes all resources used by t.

type async

The type of asynchronous computation.

val force_merge : ?hook:[ `After | `Before ] Hook.t -> t -> async

force_merge t forces a merge for t. Optionally, a hook can be passed that will be called twice:

val await : async -> unit

Wait for an asynchronous computation to finish.