package irmin-layers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature
Node values
Value types

irmin-layers
- Irmin_layers
  - Layer_id
  - Make
    
    AW
    
    K
    
    V
    
    B
    
    Branch
    
    C
    
    CA
    
    K
    
    V
    
    Commit
    
    Contents
    
    H
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    M
    
    Metadata
    
    P
    
    Private
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Private_layer
    
    Hook
    
    Repo
    
    Status
    
    Tree
    
    Contents
  - Make_ext
    
    AW
    
    K
    
    V
    
    B
    
    Branch
    
    C
    
    CA
    
    K
    
    V
    
    Commit
    
    H
    
    Contents
    
    H
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    M
    
    Metadata
    
    Node
    
    H
    
    M
    
    P
    
    P
    
    Private
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Private_layer
    
    Hook
    
    Repo
    
    Status
    
    Tree
    
    Contents
  - Maker
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    H
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    M
    
    Metadata
    
    P
    
    Private
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Private_layer
    
    Hook
    
    Repo
    
    Status
    
    Tree
    
    Contents
  - S
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    Metadata
    
    Private
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Private_layer
    
    Hook
    
    Repo
    
    Status
    
    Tree
    
    Contents
  - Stats

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module H : Irmin.Hash.S

module P : sig ... end

module M : sig ... end

Signature

Node values

type t

The type for node values.

type metadata = M.t

The type for node metadata.

type hash = H.t

The type for keys.

type step = P.step

The type for steps between nodes.

type value = [

| `Node of hash
| `Contents of hash * metadata

]

The type for either (node) keys or (contents) keys combined with their metadata.

val of_list : (step * value) list -> t

of_list l is the node n such that list n = l.

val list : 
  ?offset:int ->
  ?length:int ->
  ?cache:bool ->
  t ->
  (step * value) list

list t is the contents of t. offset and length are used to paginate results.

caching

cache regulates the caching behaviour regarding the node's internal data which may be lazily loaded from the backend, depending on the node implementation.

cache defaults to true which may greatly reduce the IOs and the runtime but may also increase the memory consumption.

cache = false doesn't replace a call to clear, it only prevents the storing of new data, it doesn't discard the existing one.

val of_seq : (unit -> (step * value) Seq.node) -> t

of_seq s is the node n such that seq n = s.

val seq : 
  ?offset:int ->
  ?length:int ->
  ?cache:bool ->
  t ->
  unit ->
  (step * value) Seq.node

seq t is the contents of t. offset and length are used to paginate results.

See caching for an explanation of the cache parameter

val empty : t

empty is the empty node.

val is_empty : t -> bool

is_empty t is true iff t is empty.

val length : t -> int

length t is the number of entries in t.

val clear : t -> unit

Cleanup internal caches.

val find : ?cache:bool -> t -> step -> value option

find t s is the value associated with s in t.

A node can point to user-defined contents. The edge between the node and the contents is labeled by a step.

See caching for an explanation of the cache parameter

val add : t -> step -> value -> t

add t s v is the node where find t v is Some s but is similar to t otherwise.

val remove : t -> step -> t

remove t s is the node where find t s is None but is similar to t otherwise.

Value types

val t : t Irmin.Type.t

t is the value type for t.

val default : metadata

default is the default metadata value.

val metadata_t : metadata Irmin.Type.t

metadata_t is the value type for metadata.

val hash_t : hash Irmin.Type.t

hash_t is the value type for hash.

val step_t : step Irmin.Type.t

step_t is the value type for step.

val value_t : value Irmin.Type.t

value_t is the value type for value.