package irmin

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Actions

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
    
    Map
    
    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

Action provides information about operations performed on a view.

Each view stores the list of actions that have already been performed on it. These actions are useful when the view needs to be rebased: write operations are replayed while read results are checked against the original run.

Signature for actions performed on a view.

Actions

type t = [

| `Read of key * value option
| `Write of key * value option
| `Rmdir of key
| `List of key * key list

]

Operations on views. The read results are kept to be able to replay them on merge and to check for possible conflict: this happens if the result read is different from the one recorded.

include Tc.S0 with type t := t

val equal : t Tc.equal

val compare : t Tc.compare

val hash : t Tc.hash

val to_json : t Tc.to_json

The REST inteface.

val of_json : t Tc.of_json

val size_of : t Tc.size_of

The serialization format.

val write : t Tc.writer

val read : t Tc.reader

val pretty : t -> string

Pretty-print an action.

val prettys : t list -> string

Pretty-print a sequence of actions.