package octez-internal-libs

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

Contents specifies how user-defined contents need to be serializable and mergeable.

The user needs to provide:

  • a type t to be used as store contents.
  • a value type for t (built using the Irmin.Type combinators).
  • a 3-way merge function, to handle conflicts between multiple versions of the same contents.

Default implementations for idempotent string and JSON contents are provided.

Values.

module type S = sig ... end
module String : S with type t = string

Contents of type string, with the default 3-way merge strategy: assume that update operations are idempotent and conflict iff values are modified concurrently.

module String_v2 : S with type t = string

Similar to String above, but the hash computation is compatible with versions older than irmin.3.0

type json = [
  1. | `Null
  2. | `Bool of bool
  3. | `String of string
  4. | `Float of float
  5. | `O of (string * json) list
  6. | `A of json list
]
module Json : S with type t = (string * json) list

Json contents are associations from strings to json values stored as JSON encoded strings. If the same JSON key has been modified concurrently with different values then the merge function conflicts.

module Json_value : S with type t = json

Json_value allows any kind of json value to be stored, not only objects.

module V1 : sig ... end
module type Store = sig ... end

Contents store.

module Store (S : Content_addressable.S) (H : Hash.S with type t = S.key) (C : S with type t = S.value) : Store with type 'a t = 'a S.t and type key = H.t and type hash = H.t and type value = C.t

Store creates a contents store.

module Store_indexable (S : Indexable.S) (H : Hash.S with type t = S.hash) (C : S with type t = S.value) : Store with type 'a t = 'a S.t and type key = S.key and type value = S.value and type hash = S.hash

Store_indexable is like Store but uses an indexable store as a backend (rather than a content-addressable one).

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