package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install

dune-project
 Dependency

Authors

Maintainers

Sources

irmin-2.7.1.tbz
sha256=fac7c032f472fb369378ad2d8fe77e7cd3b3c1c6a0d7bf59980b69528891b399
sha512=06db1c4e90d43bdfbea2d4f15037eef77207877c05019a6ce0f7f7771afe7d9200da019e3d845ff98ee86947f3e538e1521d818e6d6ddd97105fcaeb746fe418

doc/irmin-pack.layered/Irmin_pack_layered/Maker_ext/Private/Sync/index.html

Module Private.SyncSource

URI-based low-level sync.

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

Remote synchronization

Sourcetype t

The type for store handles.

Sourcetype commit = Commit.key

The type for store heads.

Sourcetype branch = Branch.key

The type for branch IDs.

Sourcetype endpoint

The type for sync endpoints.

Sourceval 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.

Sourceval 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.

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