package irmin-git

You can search for identifiers within the package.

in-package search v0.2.0

package irmin-git

irmin-git
- Irmin_git
  - Atomic_write
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Make
    
    K
    
    S
  - Branch
    
    Make
    
    B
    
    S
  - Conf
    
    Key
  - Content_addressable
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Make
    
    V
    
    S
  - G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
  - Generic_KV
    
    AW
    
    K
    
    V
    
    CA
    
    Hash
    
    Value
    
    Make
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
  - KV
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Make
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
    
    S
  - KV_maker
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Make
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
  - Maker
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Make
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Info
    
    Node
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
    
    S
  - Mem
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
  - Metadata
  - Ref
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Make
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
    
    S
  - Reference
    
    S
  - S
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Git
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
  - Schema
    
    Make
    
    B
    
    Commit
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    Hash
    
    Info
    
    Node
    
    Metadata
    
    Path
    
    V
    
    S
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Info
    
    Node
    
    Metadata
    
    Path

Legend:
Library
Module
Module type
Parameter
Class
Class type

one-to-one mapping between Irmin and Git references.

module type S = sig ... end

type t = [

| `Branch of string
| `Remote of string
| `Tag of string
| `Other of string

]

The type for Git references. Use the Branch module to only deal with `Branch values.

include S with type t := t

include Irmin.Branch.S with type t := t

Signature for Branches

val t : t Irmin.Type.t

val main : t

The name of the main branch.

val is_valid : t -> bool

Check if the branch is valid.

val pp_ref : t Fmt.t

val of_ref : string -> (t, [ `Msg of string ]) result