package irmin-fs

  1. Overview
  2. Docs

Key provides base functions for node keys.

Signature for unique identifiers.

type t = key

The type for digest hashes.

val pp : t Fmt.t

pp is the user-facing pretty-printer for paths.

val of_string : string -> (t, [ `Msg of string ]) Result.result

of_string parses paths.

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.

Value Types

val t : t Irmin.Type.t

t is the value type for t.

OCaml

Innovation. Community. Security.