package irmin

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Signature for Branches

package irmin

irmin
- Irmin
  - AO
  - AO_MAKER
    
    K
    
    V
  - Branch
    
    S
    
    STORE
    
    Key
    
    Val
    
    String
  - Contents
    
    Conv
    
    Cstruct
    
    Raw
    
    S
    
    S0
    
    STORE
    
    Key
    
    Val
    
    Store
    
    Key
    
    S
    
    Key
    
    Val
    
    Val
    
    String
  - Diff
  - Dot
    
    S
    
    Branch
    
    Commit
    
    Hash
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - Hash
    
    S
    
    SHA1
  - Info
  - KV
    
    Branch
    
    Commit
    
    Hash
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - KV_MAKER
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - LINK
  - LINK_MAKER
    
    K
  - Make
    
    AO
    
    K
    
    V
    
    B
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    Contents
    
    Hash
    
    H
    
    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
    
    RW
    
    K
    
    V
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - Make_ext
    
    Branch
    
    Commit
    
    Hash
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    Metadata
    
    P
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    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
    
    Hash
  - Merge
    
    Infix
    
    Map
    
    K
    
    MultiSet
    
    K
    
    Set
    
    E
  - Metadata
    
    None
    
    S
  - Path
    
    S
    
    String_list
  - Private
    
    Commit
    
    HISTORY
    
    History
    
    S
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Make
    
    C
    
    N
    
    S
    
    STORE
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Store
    
    N
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    S
    
    Key
    
    Val
    
    Conf
    
    Lock
    
    Make
    
    K
    
    S
    
    Node
    
    GRAPH
    
    Graph
    
    S
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Make
    
    C
    
    M
    
    N
    
    P
    
    S
    
    STORE
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Store
    
    C
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    M
    
    P
    
    S
    
    Key
    
    Val
    
    S
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Slice
    
    Make
    
    C
    
    Key
    
    Val
    
    H
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    N
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    S
    
    Sync
    
    None
    
    B
    
    H
    
    S
    
    Watch
    
    Make
    
    K
    
    V
    
    S
  - RO
  - RW
  - RW_MAKER
    
    K
    
    V
  - S
    
    Branch
    
    Commit
    
    Hash
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - SYNC
  - S_MAKER
    
    B
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    Contents
    
    Hash
    
    H
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - Sync
    
    S
    
    Branch
    
    Commit
    
    Hash
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - Type
- Irmin_fs
  - AO
    
    IO
    
    K
    
    V
  - AO_ext
    
    C
    
    IO
    
    K
    
    V
  - Config
  - IO
  - IO_mem
  - KV
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    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
    
    Hash
  - Link
    
    IO
    
    K
  - Link_ext
    
    C
    
    IO
    
    K
  - Make
    
    B
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    Contents
    
    Hash
    
    H
    
    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
    
    Hash
  - Make_ext
    
    B
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    Contents
    
    Hash
    
    H
    
    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
    
    Hash
  - RW
    
    IO
    
    K
    
    V
  - RW_ext
    
    C
    
    IO
    
    K
    
    V
- Irmin_mem
  - AO
    
    K
    
    V
  - KV
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - Link
    
    K
  - Make
    
    B
    
    Branch
    
    C
    
    Commit
    
    Hash
    
    Contents
    
    Hash
    
    H
    
    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
    
    Repo
    
    Status
    
    Tree
    
    Hash
  - RW
    
    K
    
    V

Legend:
Library
Module
Module type
Parameter
Class
Class type

Base functions on keys.

Signature for Branches

type t = key

The type for branches.

val t : t Irmin.Type.t

t is the value type for t.

val pp : t Fmt.t

pp pretty-prints branches.

val of_string : string -> (t, [ `Msg of string ]) Result.result

of_string parses branch names.

val master : t

The name of the master branch.

val is_valid : t -> bool

Check if the branch is valid.