package irmin

You can search for identifiers within the package.

in-package search v0.2.0

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

URI-based low-level sync.

include Irmin.Private.Sync.S
  with type commit_id = Commit.key
   and type branch_id = Ref.key

Remote synchronization

type t

The type for store handles.

type commit_id = Commit.key

The type for store heads.

type branch_id = Ref.key

The type for branch IDs.

val fetch : 
  t ->
  ?depth:int ->
  uri:string ->
  branch_id ->
  [ `Head of commit_id | `No_head | `Error ] 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 -> uri:string -> branch_id -> [ `Ok | `Error ] Lwt.t

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

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