package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-3.7.1.tbz
sha256=8d1a49318bda711ed44d9ea27ecd044b1d650390633d5b08f76590689c22056f
sha512=2995e6acc53dee2c59bf473c7c16c74daebfa193df552ec83ffe88fe598e26d4d8ff5da4f0cd575adaa49efa4b317d74f2c814c1b5601bed3833d76f377b6da7

doc/irmin-pack.unix/Irmin_pack_unix/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

OCaml

Innovation. Community. Security.