package irmin-indexeddb

  1. Overview
  2. Docs

Key provides base functions for node keys.

Signature for unique identifiers.

include Irmin.Hum.S with type t = key
include Tc.S0 with type t = key
type t = key
val equal : t Tc.equal
val compare : t Tc.compare
val hash : t Tc.hash
val to_json : t Tc.to_json

The REST inteface.

val of_json : t Tc.of_json
val size_of : t Tc.size_of

The serialization format.

val write : t Tc.writer
val read : t Tc.reader
val to_hum : t -> string

Display a value using its human readable representation.

val of_hum : string -> t

Convert a human readable representation of a value into its abstract value.

  • raises Invalid_argument

    if the string does not represent anything meaningful.

val digest : Cstruct.t -> t

Compute a deterministic store key from a Cstruct.t value.

val has_kind : [> `SHA1 ] -> bool

The kind of generated hash.

val to_raw : t -> Cstruct.t

The raw hash value.

val of_raw : Cstruct.t -> t

Abstract a hash value.

val digest_size : int

digest_size is the size of hash results, in bytes.