package irmin-pack

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

Parameters

module H : Irmin.Hash.S
module Node : Irmin.Private.Node.S with type hash = H.t
module Inter : INTER with type hash = H.t and type Val.metadata = Node.metadata and type Val.step = Node.step
module P : Pack.MAKER with type key = H.t and type index = Irmin_pack__.Pack_index.Make(H).t

Signature

include S with type key = H.t and type Val.metadata = Node.metadata and type Val.step = Node.step and type index = Irmin_pack__.Pack_index.Make(H).t and type value = Inter.Val.t
include Irmin.CONTENT_ADDRESSABLE_STORE with type key = H.t with type value = Inter.Val.t

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.

type -'a t

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

type key = H.t

The type for keys.

type value = Inter.Val.t

The type for raw values.

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

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

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

val add : [> Irmin.Perms.write ] t -> value -> key Lwt.t

Write the contents of a value to the store. It's the responsibility of the content-addressable store to generate a consistent key.

val unsafe_add : [> Irmin.Perms.write ] t -> key -> value -> unit Lwt.t

Same as add but allows to specify the key directly. The backend might choose to discared that key and/or can be corrupt if the key scheme is not consistent.

val clear : 'a t -> unit Lwt.t

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

type index
val v : ?fresh:bool -> ?readonly:bool -> ?lru_size:int -> index:index -> string -> Irmin.Perms.read t Lwt.t
include Irmin.Export_for_backends.Store_properties.BATCH with type 'a t := 'a t
val batch : Irmin.Perms.read t -> ([ Irmin.Perms.read | Irmin.Perms.write ] t -> 'a Lwt.t) -> 'a Lwt.t

batch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.

module Key : Irmin.Hash.S with type t = key

Signature for digest hashes, inspired by Digestif.

module Val : sig ... end
val integrity_check : offset:int64 -> length:int -> key -> _ t -> (unit, [ `Wrong_hash | `Absent_value ]) Stdlib.result
include Irmin.Export_for_backends.Store_properties.CLOSEABLE with type 'a t := 'a t
val close : 'a t -> unit Lwt.t

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

val sync : ?on_generation_change:(unit -> unit) -> 'a t -> unit
val clear_caches : 'a t -> unit
val decode_bin : dict:(int -> string option) -> hash:(int64 -> key) -> string -> int -> int
val integrity_check_inodes : [ `Read ] t -> key -> (unit, string) Stdlib.result Lwt.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