package irmin-pack

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

Module Inode.Make_persistentSource

Parameters

module H : Irmin.Hash.S
module CA : Pack_store.Maker with type hash = H.t and type index := Irmin_pack_unix__.Pack_index.Make(H).t

Signature

include Irmin.Indexable.S with type key = H.t Irmin_pack.Pack_key.t with type hash = H.t with type value = Inter.Val.t

Read-only stores

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

Sourcetype -'a t

The type for stores. The 'a phantom type carries information about the store mutability.

The type for keys.

Sourcetype value = Inter.Val.t

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

Sourcetype hash = H.t

The type of hashes of value.

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

Write the contents of a value to the store, and obtain its key.

Sourceval unsafe_add : [> Irmin.Perms.write ] t -> hash -> value -> key Lwt.t

Same as add but allows specifying the value's hash directly. The backend might choose to discard that hash and/or can be corrupt if the hash is not consistent.

Sourceval index : [> Irmin.Perms.read ] t -> hash -> key option Lwt.t

Indexing maps the hash of a value to a corresponding key of that value in the store. For stores that are addressed by hashes directly, this is typically fun _t h -> Lwt.return (Key.of_hash h); for stores with more complex addressing schemes, index may attempt a lookup operation in the store.

In general, indexing is best-effort and reveals no information about the membership of the value in the store. In particular:

  • index t hash = Some key doesn't guarantee mem t key: the value with hash hash may still be absent from the store;
  • index t hash = None doesn't guarantee that there is no key such that mem t key and Key.to_hash key = hash: the value may still be present in the store under a key that is not indexed.
Sourceval clear : 'a t -> unit Lwt.t

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

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

Sourcemodule Key : Irmin.Key.S with type t = key and type hash = hash
Sourcemodule Hash : Irmin.Hash.S with type t = hash

Signature for digest hashes, inspired by Digestif.

Sourcemodule Val : sig ... end
Sourceval decode_bin_length : string -> int -> int
Sourceval save : ?allow_non_root:bool -> 'a t -> value -> key
Sourceval v : ?fresh:bool -> ?readonly:bool -> ?lru_size:int -> index:Irmin_pack_unix__.Pack_index.Make(H).t -> indexing_strategy:Irmin_pack.Pack_store.Indexing_strategy.t -> string -> Irmin.Perms.read t Lwt.t
Sourceval integrity_check : offset:Optint.Int63.t -> length:int -> hash -> _ t -> (unit, [ `Wrong_hash | `Absent_value ]) result
Sourceval sync : 'a t -> unit
Sourceval clear_caches : 'a t -> unit
Sourceval integrity_check_inodes : [ `Read ] t -> key -> (unit, string) result Lwt.t
Sourcemodule Pack : Irmin_pack.Pack_store.S with type index := Irmin_pack_unix__.Pack_index.Make(H).t and type key := hash Irmin_pack.Pack_key.t and type hash := hash and type 'a t = 'a t
Sourcemodule Raw : sig ... end
Sourcemodule Snapshot : sig ... end
Sourceval to_snapshot : Raw.t -> Snapshot.inode
Sourceval of_snapshot : 'a t -> index:(hash -> key) -> Snapshot.inode -> value
OCaml

Innovation. Community. Security.