package octez-internal-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains some libraries used by the Octez suite

Install

dune-project

Dependency

www.tezos.com Readme Edit opam file Versions (1)

Authors

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-internal-libs.irmin/Irmin/Contents/index.html

Module `Irmin.Contents`Source

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.

Sourcemodule type S = sig ... end

Sourcemodule 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.

Sourcemodule String_v2 : S with type t = string

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

Sourcetype json = [

| `Null
| `Bool of bool
| `String of string
| `Float of float
| `O of (string * json) list
| `A of json list

]

Sourcemodule 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.

Sourcemodule Json_value : S with type t = json

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

Sourcemodule V1 : sig ... end

Sourcemodule type Store = sig ... end

Contents store.

Source

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.

Source

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).