package irmin-pack

You can search for identifiers within the package.

in-package search v0.2.0

Irmin backend which stores values in a pack file

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (44)

Authors

T

Thomas Gazagnaire

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.6.1.tbz

sha256=11fc2570bdbfd48478c89113fc801084a84a9a2c12d9bf8c64e05ce64ae19bd7

sha512=2171699ca24dec5c9c908a2676b272e034c14eb17f7052a794535e52af0be40be68a689e59c0a640ee244b11703320483f4d0c261542e6242ba23a8f1272b9b0

doc/irmin-pack.unix/Irmin_pack_unix/Inode/Make_persistent/index.html

Module `Inode.Make_persistent`Source

Parameters

module H : Irmin.Hash.S

module Node : 
  Irmin.Node.Generic_key.S
    with type hash = H.t
     and type contents_key = H.t Pack_key.t
     and type node_key = H.t Pack_key.t

module Inter : 
  Irmin_pack.Inode.Internal
    with type hash = H.t
     and type key = H.t Pack_key.t
     and type Snapshot.metadata = Node.metadata
     and type Val.step = Node.step

module Pack : 
  Pack_store.S
    with type hash = H.t
     and type key = H.t Pack_key.t
     and type value = Inter.Raw.t

Signature

include Irmin_pack.Inode.S
  with type key = H.t Pack_key.t
  with type hash = H.t
  with type Val.metadata = Node.metadata
  with type Val.step = Node.step
  with type value = Inter.Val.t

include Irmin.Indexable.S
  with type key = H.t 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.

Sourcetype key = H.t Pack_key.t

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.

Source

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.

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.

Source

val unsafe_find : 
  check_integrity:bool ->
  [< Irmin.Perms.read ] t ->
  key ->
  value option

Sourcemodule Val : sig ... end

Sourceval decode_bin_length : string -> int -> int

Sourceval save : ?allow_non_root:bool -> 'a t -> value -> key

Sourcetype file_manager = Pack.file_manager

Sourcetype dict = Pack.dict

Sourcetype dispatcher = Pack.dispatcher

Source

val v : 
  config:Irmin.Backend.Conf.t ->
  fm:file_manager ->
  dict:dict ->
  dispatcher:dispatcher ->
  Irmin.Perms.read t

include Irmin_pack.Checkable with type 'a t := 'a t and type hash := hash

Source

val integrity_check : 
  offset:Optint.Int63.t ->
  length:int ->
  hash ->
  _ t ->
  (unit, [ `Wrong_hash | `Absent_value ]) result

Sourceval integrity_check_inodes : [ `Read ] t -> key -> (unit, string) result Lwt.t

Source

module Pack : 
  Pack_store.S
    with type file_manager = file_manager
     and type dict = dict
     and type dispatcher = dispatcher
     and type key := hash Pack_key.t
     and type hash := hash
     and type 'a t = 'a t

Source

module Raw : 
  Irmin_pack.Inode.Raw
    with type t = Pack.value
     and type hash := hash
     and type key := hash Pack_key.t

Source

module Snapshot : 
  Irmin_pack.Inode.Snapshot
    with type hash = hash
     and type metadata = Val.metadata

Sourceval to_snapshot : Raw.t -> Snapshot.inode

Sourceval of_snapshot : 'a t -> index:(hash -> key) -> Snapshot.inode -> value

Sourceval purge_lru : 'a t -> unit

Sourceval key_of_offset : 'a t -> Optint.Int63.t -> key

Sourceval unsafe_find_no_prefetch : 'a t -> key -> value option

On This Page

Parameters
Signature

package irmin-pack

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/Inode/Make_persistent/index.html

Module Inode.Make_persistentSource

Parameters

Signature

Read-only stores

Module `Inode.Make_persistent`Source