package irmin

  1. Overview
  2. Docs
package irmin
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file info_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
(*
 * Copyright (c) 2013-2022 Thomas Gazagnaire <thomas@gazagnaire.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

(** {1 Commit Info} *)

module type S = sig
  type author = string [@@deriving irmin]
  type message = string [@@deriving irmin]

  type t [@@deriving irmin]
  (** The type for commit info. *)

  val v : ?author:author -> ?message:message -> int64 -> t
  (** Create a new commit info. *)

  val 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 {e Date} field and
      is expected to be the number of POSIX seconds (thus not counting leap
      seconds) since the Epoch. *)

  val 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 {e Author} field. *)

  val message : t -> message
  (** [message t] is [t]'s commit message. *)

  val empty : t
  (** The empty commit info. *)

  (** {1 Info Functions} *)

  type f = unit -> t
  (** Alias for functions which can build commit info. *)

  val none : f
  (** The empty info function. [none ()] is [empty] *)
end

module type Sigs = sig
  module type S = S

  module Default : S

  type default = Default.t
end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct