package irmin-containers

You can search for identifiers within the package.

in-package search v0.2.0

irmin-containers
- Irmin_containers
  - Blob_log
    
    FS
    
    Make
    
    T
    
    Mem
    
    S
  - Cas_maker
  - Counter
    
    FS
    
    Make
    
    Mem
    
    S
  - Linked_log
    
    FS
    
    C
    
    Make
    
    C
    
    T
    
    Mem
    
    C
    
    S
  - Lww_register
    
    FS
    
    Make
    
    T
    
    Mem
    
    S
  - Time
    
    Machine
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

URI-based low-level sync.

include Irmin.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.

type endpoint

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