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-2.9.1.tbz
sha256=16003a8a873737b0a8ae2a940399b14754c5c2ba506e4511b96df4473e912783
sha512=64682e67c1e9f6b6f6a5f017da7c0d7e5316e2dd139ad8ad7ad43b73003d827fb9f3141c10469986dee47849687c841a297b91d08186f72268c41e026810a647

doc/irmin/Irmin/Info/index.html

Module Irmin.InfoSource

Commit info are used to keep track of the origin of write operations in the stores. Info models the metadata associated with commit objects in Git.

Commit Info

Sourcetype t

The type for commit info.

Sourceval v : date:int64 -> author:string -> string -> 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 create 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 -> string

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 -> string

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

Value Types

Sourceval t : t Type.t

t is the value type for t.

OCaml

Innovation. Community. Security.