package irmin

You can search for identifiers within the package.

in-package search v0.2.0

package irmin

irmin
- Irmin
  - AO
  - AO_MAKER
    
    K
    
    V
  - AO_MAKER_RAW
    
    K
    
    V
  - BC
    
    History
    
    E
    
    V
    
    Repo
  - Contents
    
    Cstruct
    
    Json
    
    Make
    
    Key
    
    S
    
    Key
    
    Val
    
    Path
    
    Step
    
    Val
    
    S
    
    Path
    
    Step
    
    STORE
    
    Key
    
    Path
    
    Step
    
    Val
    
    String
  - Dot
    
    S
    
    Hash
    
    History
    
    E
    
    V
    
    Key
    
    Step
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - HRW
  - Hash
    
    S
    
    SHA1
  - Hum
    
    S
  - LINK
  - LINK_MAKER
    
    K
  - Make
    
    AO
    
    K
    
    V
    
    C
    
    Path
    
    Step
    
    H
    
    Hash
    
    History
    
    E
    
    V
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    R
    
    RW
    
    K
    
    V
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - Make_ext
    
    Hash
    
    History
    
    E
    
    V
    
    Key
    
    Step
    
    P
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Path
    
    Step
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - Merge
    
    MSet
    
    M
    
    Map
    
    M
    
    X
    
    OP
    
    Result
  - Path
    
    S
    
    Step
    
    String_list
    
    Step
  - Private
    
    Commit
    
    HISTORY
    
    Store
    
    Key
    
    Val
    
    History
    
    N
    
    Key
    
    Path
    
    Step
    
    Val
    
    S
    
    Key
    
    Val
    
    Store
    
    Key
    
    Val
    
    Make
    
    C
    
    N
    
    S
    
    STORE
    
    Key
    
    Val
    
    Conf
    
    Lock
    
    Make
    
    K
    
    S
    
    Node
    
    GRAPH
    
    Store
    
    Key
    
    Path
    
    Step
    
    Val
    
    Graph
    
    C
    
    Key
    
    Path
    
    Step
    
    Val
    
    S
    
    Key
    
    Val
    
    Store
    
    Key
    
    Path
    
    Step
    
    Val
    
    Make
    
    C
    
    N
    
    P
    
    Step
    
    S
    
    STORE
    
    Key
    
    Path
    
    Step
    
    Val
    
    S
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Path
    
    Step
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Slice
    
    Make
    
    C
    
    Key
    
    Path
    
    Step
    
    Val
    
    H
    
    Key
    
    Val
    
    N
    
    Key
    
    Path
    
    Step
    
    Val
    
    S
    
    Sync
    
    None
    
    H
    
    R
    
    S
    
    Watch
    
    Make
    
    K
    
    V
    
    S
  - RAW
  - RO
  - RRW
  - RW
  - RW_MAKER
    
    K
    
    V
  - Ref
    
    S
    
    STORE
    
    Key
    
    Val
    
    String
  - S
    
    Hash
    
    History
    
    E
    
    V
    
    Key
    
    Step
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - SYNC
  - S_MAKER
    
    C
    
    Path
    
    Step
    
    H
    
    Hash
    
    History
    
    E
    
    V
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    R
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - Sync
    
    S
    
    Hash
    
    History
    
    E
    
    V
    
    Key
    
    Step
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - Task
  - VIEW
    
    Action
  - View
    
    Action
    
    S
    
    Hash
    
    History
    
    E
    
    V
    
    Key
    
    Step
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
irmin.fs
- Irmin_fs
  - AO
    
    IO
    
    K
    
    V
  - AO_ext
    
    C
    
    IO
    
    K
    
    V
  - Config
  - IO
  - LOCK
  - Link
    
    IO
    
    K
  - Link_ext
    
    C
    
    IO
    
    K
  - Make
    
    C
    
    Path
    
    Step
    
    H
    
    Hash
    
    History
    
    E
    
    V
    
    IO
    
    L
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    R
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - Make_ext
    
    C
    
    Path
    
    Step
    
    H
    
    Hash
    
    History
    
    E
    
    V
    
    IO
    
    L
    
    Obj
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    R
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - RW
    
    IO
    
    K
    
    L
    
    V
  - RW_ext
    
    C
    
    IO
    
    K
    
    L
    
    V
irmin.mem
- Irmin_mem
  - AO
    
    K
    
    V
  - Link
    
    K
  - Make
    
    C
    
    Path
    
    Step
    
    H
    
    Hash
    
    History
    
    E
    
    V
    
    Private
    
    Commit
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Key
    
    Val
    
    Ref
    
    Key
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    R
    
    Ref
    
    Repo
    
    Val
    
    Path
    
    Step
  - RW
    
    K
    
    V

Legend:
Library
Module
Module type
Parameter
Class
Class type

Private contents.

include Irmin.AO with type value = value

Append-only stores

include Irmin.RO with type value = value

Read-only stores

type t

Type for stores.

type key

Type for keys.

type value = value

Type for values.

val read : t -> key -> value option Lwt.t

Read a value from the store.

val read_exn : t -> key -> value Lwt.t

Same as read but raise Invalid_argument if the key does not exist.

val mem : t -> key -> bool Lwt.t

Check if a key exists.

val iter : t -> (key -> value Lwt.t -> unit Lwt.t) -> unit Lwt.t

iter t fn call the function fn on all t's keys and values.

val add : t -> value -> key Lwt.t

Write the contents of a value to the store. It's the responsibility of the append-only store to generate a consistent key.

module Path = Key

The type for store paths.

val merge : Path.t -> t -> key option Irmin.Merge.t

merge t lifts the merge functions defined on contents values to contents key. The merge function will: (i) read the values associated with the given keys, (ii) use the merge function defined on values and (iii) write the resulting values into the store to get the resulting key. See Contents.S.merge.

If any of these operations fail, return `Conflict.

module Key : Irmin.Hash.S with type t = key

Key provides base functions for user-defined contents keys.

module Val : Irmin.Contents.S with type t = value and module Path = Path

Val provides base functions for user-defined contents values.