package irmin-git

You can search for identifiers within the package.

in-package search v0.2.0

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
    
    K
  - BRANCH
  - Branch
    
    B
  - Content_addressable
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    V
  - G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
  - Generic
    
    AW
    
    K
    
    V
    
    B
    
    Branch
    
    C
    
    CA
    
    K
    
    V
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Key
    
    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
    
    Contents
    
    Env
    
    Proof
  - Generic_KV
    
    AW
    
    K
    
    V
    
    Branch
    
    C
    
    CA
    
    K
    
    V
    
    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
    
    Contents
    
    Env
    
    Proof
  - KV
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof
  - KV_MAKER
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof
  - Make
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof
  - Make_ext
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof
  - Mem
    
    Hash
    
    Map
    
    Set
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Map
    
    Set
    
    Commit
    
    Map
    
    Set
    
    Map
    
    Set
    
    Tag
    
    Map
    
    Set
    
    Tree
    
    Map
    
    Set
  - Metadata
  - REF_MAKER
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof
  - Ref
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof
  - Reference
  - S
    
    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
    
    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
    
    Contents
    
    Env
    
    Proof
  - S_MAKER
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    G
    
    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
    
    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
    
    S
    
    Status
    
    Tree
    
    Contents
    
    Env
    
    Proof

Legend:
Library
Module
Module type
Parameter
Class
Class type

URI-based low-level sync.

include Irmin.Sync.S
  with type commit = Commit.key
   and type branch = Branch.key
  with type endpoint = Mimic.ctx * Smart_git.Endpoint.t

Remote synchronization

type t

The type for store handles.

type commit = Commit.key

The type for store heads.

type branch = Branch.key

The type for branch IDs.

type endpoint = Mimic.ctx * Smart_git.Endpoint.t

The type for sync endpoints.

val fetch : 
  t ->
  ?depth:int ->
  endpoint ->
  branch ->
  (commit option, [ `Msg of string ]) result Lwt.t

fetch t uri fetches the contents of the remote store located at uri into the local store t. Return the head of the remote branch with the same name, which is now in the local store. No_head means no such branch exists.

val push : 
  t ->
  ?depth:int ->
  endpoint ->
  branch ->
  (unit, [ `Msg of string | `Detached_head ]) result Lwt.t

push t uri pushes the contents of the local store t into the remote store located at uri.

val v : Repo.t -> t Lwt.t