package irmin

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

RW_MAKER is the signature exposed by read-write store backends. K is the implementation of keys and V is the implementation of values.

Parameters

module K : Hum.S
module V : Tc.S0

Signature

include RRW with type key = K.t and type value = V.t

Reactive read-write stores

Reactive read-write stores are read-write stores with reactive capabilities.

include RW with type key = K.t with type value = V.t

Read-write stores

include RO with type key = K.t with type value = V.t

Read-only stores

type t

Type for stores.

type key = K.t

Type for keys.

type value = V.t

Type for values.

val read : t -> key -> value option Lwt.t

Read a value from the store.

val read_exn : t -> key -> value Lwt.t

Same as read but raise Invalid_argument if the key does not exist.

val mem : t -> key -> bool Lwt.t

Check if a key exists.

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

iter t fn call the function fn on all t's keys and values.

val update : t -> key -> value -> unit Lwt.t

update t k v replaces the contents of k by v in t. If k is not already defined in t, create a fresh binding. Raise Invalid_argument if k is the empty path.

val compare_and_set : t -> key -> test:value option -> set:value option -> bool Lwt.t

compare_and_set t key ~test ~set sets key to set only if the current value of key is test and in that case returns true. If the current value of key is different, it returns false. None means that the value does not have to exist or is removed.

Note: The operation is guaranteed to be atomic.

val remove : t -> key -> unit Lwt.t

remove t k remove the key k in t.

type watch

The type of watch handlers.

val watch_key : t -> key -> ?init:value -> (value diff -> unit Lwt.t) -> watch Lwt.t

watch_key t k ?init f adds f to the list of t's watch handlers for the key k and returns the watch handler to be used with unwatch. init is the optional initial value of the key.

val watch : t -> ?init:(key * value) list -> (key -> value diff -> unit Lwt.t) -> watch Lwt.t

watch t ?init f adds f to the list of t's watch handlers and returns the watch handler to be used with unwatch. init is the optional initial values. It is more efficient to use watch_key to watch only a single given key.

val unwatch : t -> watch -> unit Lwt.t

unwatch t w removes w from t's watch handlers.

val create : config -> t Lwt.t
OCaml

Innovation. Community. Security.