package irmin

  1. Overview
  2. Docs
On This Page
  1. Branch Store
package irmin
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Backend.BranchSource

A branch store.

Branch Store

include Irmin.Atomic_write.S with type key = Schema.Branch.t with type value = Commit.key

Atomic write stores

Atomic-write stores are stores where it is possible to read, update and remove elements, with atomically guarantees.

Sourcetype t

The type for atomic-write backend stores.

Read-only stores

Read-only stores are store where it is only possible to read existing values.

The type for keys.

Sourcetype value = Commit.key

The type for raw values.

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

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

Sourceval find : t -> key -> value option Lwt.t

find t k is Some v if k is associated to v in t and None is k is not present in t.

Sourceval set : t -> key -> value -> unit Lwt.t

set 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.

Sourceval test_and_set : t -> key -> test:value option -> set:value option -> bool Lwt.t

test_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.

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

remove t k remove the key k in t.

Sourceval list : t -> key list Lwt.t

list t it the list of keys in t.

Sourcetype watch

The type of watch handlers.

Sourceval watch : t -> ?init:(key * value) list -> (key -> value Irmin.Diff.t -> 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.

Sourceval watch_key : t -> key -> ?init:value -> (value Irmin.Diff.t -> 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.

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

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

Sourceval clear : t -> unit Lwt.t

Clear the store. This operation is expected to be slow.

Sourceval close : t -> unit Lwt.t

close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.

Sourcemodule Key : sig ... end

Base functions on keys.

Sourcemodule Val : Irmin.Key.S with type t = value

Base functions on values.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct