package irmin

  1. Overview
  2. Docs
package irmin
Legend:
Library
Module
Module type
Parameter
Class
Class type

None is an implementation of S which does nothing.

Parameters

module H : Type.S
module B : Type.S

Signature

include S with type commit = H.t and type branch = B.t

Remote synchronization

type t

The type for store handles.

type commit = H.t

The type for store heads.

type branch = B.t

The type for branch IDs.

type endpoint

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 : 'a -> t Lwt.t

Create a remote store handle.