package octez-internal-libs

  1. Overview
  2. Docs
package octez-internal-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file snapshot_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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
(*
 * Copyright (c) 2018-2022 Tarides <contact@tarides.com>
 *
 * 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.
 *)

open! Import

module type Args = sig
  module Hash : Irmin.Hash.S
  module Fm : File_manager.S
  module Dispatcher : Dispatcher.S with module Fm = Fm

  module Inode :
    Inode.Persistent
      with type hash := Hash.t
       and type key = Hash.t Pack_key.t
       and type file_manager = Fm.t
       and type dispatcher = Dispatcher.t

  module Contents_pack :
    Pack_store.S
      with type hash := Hash.t
       and type key = Hash.t Pack_key.t
       and type dispatcher = Dispatcher.t
end

module type Sigs = sig
  module Make (Args : Args) : sig
    open Args

    module Export : sig
      type t

      val v : Irmin.config -> read Contents_pack.t -> read Inode.Pack.t -> t

      val run :
        ?on_disk:[ `Path of string ] ->
        t ->
        (Contents_pack.value -> unit Lwt.t) ->
        (Inode.Snapshot.inode -> unit Lwt.t) ->
        Hash.t Pack_key.t * Pack_value.Kind.t ->
        int Lwt.t

      val close :
        t ->
        ( unit,
          [> `Double_close
          | `Index_failure of string
          | `Io_misc of Fm.Io.misc_error
          | `Pending_flush
          | `Ro_not_allowed ] )
        result
    end

    module Import : sig
      type t

      val v :
        ?on_disk:[ `Path of string | `Reuse ] ->
        int ->
        read Contents_pack.t ->
        read Inode.Pack.t ->
        t

      val save_contents : t -> Contents_pack.value -> Hash.t Pack_key.t Lwt.t
      val save_inodes : t -> Inode.Snapshot.inode -> Hash.t Pack_key.t Lwt.t
      val close : t -> unit
    end
  end
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