package irmin-pack

  1. Overview
  2. No Docs
Irmin backend which stores values in a pack file

Install 

dune-project
 Dependency

github.com Edit opam file Versions (9)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.5.2.tbz
sha256=2a1e6a7577e498fbfeb678d666da210dc48d1344637e8ecb653e1dd88c640b5f
sha512=3fb6f49a1af2f8bab1df5b6f5affaaa09f09fe892a08eb2d9de58138e56646d4a6797f3c087b22875e36e3411218ab2435fe5437ac78f323dd661932af021fad

doc/irmin-pack/Irmin_pack/Atomic_write/Closeable/index.html

Module Atomic_write.CloseableSource

Parameters

module AW : S

Signature

include S with type key = AW.key and type value = AW.value and type watch = AW.watch
include Irmin.Atomic_write.S with type key = AW.key with type value = AW.value with type watch = AW.watch

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.

Sourcetype key = AW.key

The type for keys.

Sourcetype value = AW.value

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 = AW.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.

Sourceval flush : t -> unit
Sourceval make_closeable : AW.t -> t