package irmin-fs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package irmin-fs

irmin-fs
- Irmin_fs
  - Append_only
    
    IO
    
    K
    
    V
  - Append_only_ext
    
    C
    
    IO
    
    K
    
    V
  - Atomic_write
    
    IO
    
    K
    
    V
  - Atomic_write_ext
    
    C
    
    IO
    
    K
    
    V
  - Config
  - IO
  - IO_mem
  - KV
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    IO
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Contents
  - Make
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    H
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    IO
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Contents
  - Make_ext
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    H
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    IO
    
    Key
    
    M
    
    Metadata
    
    Obj
    
    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
    
    Ref
    
    Repo
    
    Status
    
    Tree
    
    Contents

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module IO : IO

module C : Config

module K : Irmin.Type.S

module V : Irmin.Type.S

Signature

include Irmin.APPEND_ONLY_STORE with type key = K.t and type value = V.t

Append-only stores

Append-onlye stores are store where it is possible to read and add new values.

type 'a t

The type for append-only backend stores. The 'a phantom type carries information about the store mutability.

type key = K.t

The type for keys.

type value = V.t

The type for raw values.

val mem : [> `Read ] t -> key -> bool Lwt.t

mem t k is true iff k is present in t.

val find : [> `Read ] t -> key -> value option Lwt.t

find t k is Some v if k is associated to v in t and None is k is not present in t.

val add : [> `Write ] t -> key -> value -> unit Lwt.t

Write the contents of a value to the store.

val clear : 'a t -> unit Lwt.t

Clear the store. This operation is expected to be slow.

val batch : [ `Read ] t -> ([ `Read | `Write ] t -> 'a Lwt.t) -> 'a Lwt.t

batch t f applies the writes in f in a separate batch. The exact guarantees depends on the backends.

val v : Irmin.config -> [ `Read ] t Lwt.t

v config is a function returning fresh store handles, with the configuration config, which is provided by the backend.

val close : 'a t -> unit Lwt.t

close t frees up all the resources associated to t. Any operations run on a closed store will raise Closed.