package irmin-fs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Remote synchronization

package irmin-fs

irmin-fs
- Irmin_fs
  - Append_only
    
    IO
  - Append_only_ext
    
    C
    
    IO
  - Atomic_write
    
    IO
  - Atomic_write_ext
    
    C
    
    IO
  - Config
  - IO
  - IO_mem
  - KV
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    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
    
    Contents
  - Make
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    H
    
    Hash
    
    Head
    
    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
    
    Contents
  - Make_ext
    
    B
    
    Branch
    
    C
    
    Commit
    
    Contents
    
    H
    
    Hash
    
    Head
    
    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
    
    Contents

Legend:
Library
Module
Module type
Parameter
Class
Class type

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 = unit

The type for sync endpoints.

val fetch : 
  t ->
  ?depth:int ->
  endpoint ->
  branch ->
  (commit option, [ `Msg of string ]) Stdlib.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 ]) Stdlib.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