Source file `checks_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
open! Import

type empty = |

module type S = sig
  module Stat : sig
    val run : root:string -> unit
    (** Read basic metrics from an existing store. *)

    val term : (unit -> unit) Cmdliner.Term.t
    (** A pre-packaged [Cmdliner] term for executing {!run}. *)
  end

  module Integrity_check : sig
    val run : root:string -> unit
    (** Check that the integrity invariants of a store are preserved, and
        display any broken invariants. *)

    val term : (unit -> unit) Cmdliner.Term.t
    (** A pre-packaged [Cmdliner] term for executing {!run}. *)
  end

  val cli : unit -> empty
  (** Run a [Cmdliner] binary containing tools for running offline integrity
      checks. *)
end

module type Platform_args = sig
  module IO : Io.S
  module Clock : Platform.CLOCK
end

module type Checks = sig
  type nonrec empty = empty

  module type S = S
  module type Platform_args = Platform_args

  module Make (K : Data.Key) (V : Data.Value) (_ : Platform_args) : S
end