package irmin-client

  1. Overview
  2. Docs
A client for irmin-server

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (2)

Authors

  1. Z
    Zach Shipko <zachshipko@gmail.com>

Maintainers

  1. Z
    Zach Shipko <zachshipko@gmail.com>

Sources

irmin-3.11.0.tbz
sha256=09996fbcc2c43e117a9bd8e9028c635e81cccb264d5e02d425ab8b06bbacdbdb
sha512=0391a6bf7b94a1edd50a3a8df9e58961739fa78d7d689d61f56bc87144483bad2ee539df595c33d9d52c29b3458da5dddf3a73b5eb85e49c4667c26d2cd46be1

doc/irmin-client.jsoo/Irmin_client_jsoo/Make_codec/Batch/index.html

Module Make_codec.BatchSource

The batch API is used to have better control of when data is sent between the client and server when manipulating trees.

module Request_tree : Irmin_server.Tree.S
Sourcetype store = t
Sourcetype t = (path * [ `Contents of [ `Hash of hash | `Value of contents ] * metadata option | `Tree of Request_tree.t | `Remove ]) list

A batch is list of updates and their associated paths

Sourceval v : unit -> t

val () creates a new batch

Sourceval add_value : path -> ?metadata:metadata -> contents -> t -> t

add_value path ~metadata value batch will add value at path with associated metadata when batch is apply'd

Sourceval add_hash : path -> ?metadata:metadata -> hash -> t -> t

add_hash path ~metadata hash batch will add hash at path with associated metadata when batch is apply'd

Sourceval add_tree : path -> tree -> t -> t Lwt.t

add_tree path batch will add tree at path when batch is apply'd

Note: if tree has been modified locally, calls to the server may be made.

Sourceval remove : path -> t -> t

remove path batch will remove path when batch is apply'd

Sourceval apply : info:Info.f -> ?path:path -> store -> t -> commit_key Lwt.t

apply ~info ~path store batch applies batch to the subtree at path (defaults to the root) in store. The key of the commit is returned.