package irmin

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Signature for Branches

irmin
- Irmin
  - APPEND_ONLY_STORE
  - APPEND_ONLY_STORE_MAKER
    
    K
    
    V
  - ATOMIC_WRITE_STORE
  - ATOMIC_WRITE_STORE_MAKER
    
    K
    
    V
  - Branch
    
    S
    
    STORE
    
    Key
    
    Val
    
    String
  - CONTENT_ADDRESSABLE_STORE
  - CONTENT_ADDRESSABLE_STORE_MAKER
    
    K
    
    V
  - Content_addressable
    
    K
    
    S
    
    K
    
    V
    
    V
  - Contents
    
    Json
    
    Json_value
    
    S
    
    STORE
    
    Key
    
    Val
    
    Store
    
    Key
    
    S
    
    Key
    
    Val
    
    Val
    
    String
    
    V1
    
    String
  - Diff
  - Dot
    
    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
    
    Repo
    
    Status
    
    Tree
  - Hash
    
    BLAKE2B
    
    BLAKE2S
    
    Make
    
    H
    
    Make_BLAKE2B
    
    D
    
    Make_BLAKE2S
    
    D
    
    RMD160
    
    S
    
    SHA1
    
    SHA224
    
    SHA256
    
    SHA384
    
    SHA512
    
    TYPED
    
    Typed
    
    K
    
    V
    
    V1
    
    H
  - Info
  - Json_tree
    
    Store
    
    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
    
    Repo
    
    Status
    
    Tree
  - KV
    
    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
    
    Repo
    
    Status
    
    Tree
  - KV_MAKER
    
    Branch
    
    C
    
    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
    
    Repo
    
    Status
    
    Tree
  - 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
    
    Repo
    
    Status
    
    Tree
  - Make_ext
    
    AW
    
    K
    
    V
    
    Branch
    
    CA
    
    K
    
    V
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    Metadata
    
    Node
    
    Path
    
    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
  - Merge
    
    Infix
    
    Map
    
    K
    
    MultiSet
    
    K
    
    Set
    
    E
  - Metadata
    
    None
    
    S
  - Of_private
    
    Branch
    
    Commit
    
    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
    
    Hash
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Repo
    
    Status
    
    Tree
  - Path
    
    S
    
    String_list
  - Private
    
    Commit
    
    HISTORY
    
    History
    
    S
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Make
    
    K
    
    S
    
    STORE
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Store
    
    Key
    
    N
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    S
    
    Key
    
    Val
    
    V1
    
    S
    
    Conf
    
    Lock
    
    Make
    
    K
    
    S
    
    Node
    
    GRAPH
    
    Graph
    
    S
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Make
    
    K
    
    M
    
    P
    
    S
    
    STORE
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Store
    
    C
    
    Key
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Key
    
    M
    
    P
    
    S
    
    Key
    
    Val
    
    V1
    
    S
    
    S
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Hash
    
    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
  - 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
    
    Repo
    
    Status
    
    Tree
  - SYNC
  - S_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
    
    Repo
    
    Status
    
    Tree
  - Sync
    
    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
    
    Repo
    
    Status
    
    Tree
  - Type
    
    Json
    
    S
irmin.type
- Irmin_type
  - Json
  - S

Legend:
Library
Module
Module type
Parameter
Class
Class type

The signature for branches. Irmin branches are similar to Git branches: they are used to associated user-defined names to head commits. Branches have a default value: the master branch.

Signature for Branches

type t

The type for branches.

val t : t Type.t

t is the value type for t.

val master : t

The name of the master branch.

val is_valid : t -> bool

Check if the branch is valid.