package datakit

You can search for identifiers within the package.

in-package search v0.2.0

datakit
- Datakit
  - Blob
  - Dir
  - VFS
  - Vfs

Legend:
Library
Module
Module type
Parameter
Class
Class type

URI-based low-level sync.

include Irmin.Private.Sync.S
  with type commit = Commit.key
   and type branch = Branch.key

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.

val fetch : 
  t ->
  ?depth:int ->
  uri:string ->
  branch ->
  (commit, [ `No_head | `Not_available | `Msg of string ]) Result.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 ->
  uri:string ->
  branch ->
  (unit, [ `No_head | `Not_available | `Msg of string | `Detached_head ])
    Result.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