package irmin

  1. Overview
  2. Docs
Irmin, a distributed database that follows the same design principles as Git

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-3.9.0.tbz
sha256=8e073abe1b5ffb5b6d58c32606c9d7dabc32c53501756be80a92ed4777ad51a0
sha512=70769a8d36520626fecd6f68e5f3abe6a0d67a65af915312206cc3f4da230df48512faee178aa6e899d3fb640b9340f6c92486185be5432a1a1a161c70386c99

doc/irmin.mem/Irmin_mem/KV/Make/Info/index.html

Module Make.InfoSource

Sourcetype author = string
Sourceval author_t : author Irmin.Type.t
Sourcetype message = string
Sourceval message_t : message Irmin.Type.t
Sourcetype t = info

The type for commit info.

Sourceval v : ?author:author -> ?message:message -> int64 -> t

Create a new commit info.

Sourceval date : t -> int64

date t is t's commit date.

The date provided by the user when calling the v function. Rounding Unix.gettimeofday () (when available) is a good value for such date. On more esoteric platforms, any monotonic counter is a fine value as well. On the Git backend, the date is translated into the commit Date field and is expected to be the number of POSIX seconds (thus not counting leap seconds) since the Epoch.

Sourceval author : t -> author

author t is t's commit author.

The author identifies the entity (human, unikernel, process, thread, etc) performing an operation. For the Git backend, this will be directly translated into the Author field.

Sourceval message : t -> message

message t is t's commit message.

Sourceval empty : t

The empty commit info.

Info Functions

Sourcetype f = unit -> t

Alias for functions which can build commit info.

Sourceval none : f

The empty info function. none () is empty

Sourceval pp : t Fmt.t

pp is a pretty-printer for info.

OCaml

Innovation. Community. Security.