package irmin

  1. Overview
  2. Docs
On This Page
  1. Value Types
Irmin, a distributed database that follows the same design principles as Git

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Gazagnaire
  2. T
    Thomas Leonard

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.11.0.tbz
sha256=09996fbcc2c43e117a9bd8e9028c635e81cccb264d5e02d425ab8b06bbacdbdb
sha512=0391a6bf7b94a1edd50a3a8df9e58961739fa78d7d689d61f56bc87144483bad2ee539df595c33d9d52c29b3458da5dddf3a73b5eb85e49c4667c26d2cd46be1

doc/irmin.mem/Irmin_mem/KV/Make/Schema/Hash/index.html

Module Schema.HashSource

Signature for digest hashes, inspired by Digestif.

Sourcetype t = hash

The type for digest hashes.

Sourceval hash : ((string -> unit) -> unit) -> t

Compute a deterministic store key from a sequence of strings.

Sourceval short_hash : t -> int

short_hash h is a small hash of h, to be used for instance as the `hash` function of an OCaml Hashtbl.

Sourceval hash_size : int

hash_size is the size of hash results, in bytes.

Sourceval to_raw_string : t -> string

to_raw_string t is the raw sequence of bytes in t (of length hash_size).

Sourceval unsafe_of_raw_string : string -> t

unsafe_of_raw_string b is the hash consisting of the raw sequence of bytes b.

Warning: this function cannot guarantee that the supplied byte string is a valid output of the hash process, so should only be used on strings that are known to have been built with to_raw_string.

Sourceval short_hash_substring : Bigstringaf.t -> off:int -> int

short_hash_substring t off computes the short-hash of the raw hash data contained in t at offset off. It has behaviour equivalent to:

  Bigstringaf.substring t ~off ~len:hash_size
  |> unsafe_of_raw_string
  |> short_hash

but may be more efficient due to not needing to allocate an intermediate string.

Value Types

t is the value type for t.