package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Content_addressable.CloseableSource

Parameters

module CA : S

Signature

include S with type key = CA.key and type value = CA.value
include Irmin.CONTENT_ADDRESSABLE_STORE with type key = CA.key with type value = CA.value

Content-addressable stores

Content-addressable stores are store where it is possible to read and add new values. Keys are derived from the values raw contents and hence are deterministic.

Sourcetype -'a t

The type for content-addressable backend stores. The 'a phantom type carries information about the store mutability.

Sourcetype key = CA.key

The type for keys.

Sourcetype value = CA.value

The type for raw values.

Sourceval mem : [> Irmin.Perms.read ] t -> key -> bool Lwt.t

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

Sourceval find : [> Irmin.Perms.read ] 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 clear : 'a t -> unit Lwt.t

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

Sourceval add : 'a t -> value -> key Lwt.t

Overwrite add to work with a read-only database handler.

Sourceval unsafe_add : 'a t -> key -> value -> unit Lwt.t

Overwrite unsafe_add to work with a read-only database handler.

Sourceval unsafe_append : ensure_unique:bool -> overcommit:bool -> 'a t -> key -> value -> unit
Sourceval unsafe_mem : 'a t -> key -> bool
Sourceval unsafe_find : check_integrity:bool -> 'a t -> key -> value option
Sourceval generation : 'a t -> Optint.Int63.t

The number of times that clear has been called on this store.

Sourceval clear_keep_generation : 'a t -> unit Lwt.t
Sourceval close : _ t -> unit Lwt.t
Sourceval make_closeable : 'a CA.t -> 'a t
Sourceval get_open_exn : 'a t -> 'a CA.t
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