package irmin-containers

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

Make returns a mergeable linked log using the backend and other parameters as specified by the user.

Parameters

module Backend : sig ... end
module C : sig ... end
module T : Time.S
module K : Irmin.Hash.S
module V : Irmin.Type.S

Signature

module Store : Irmin.S with type branch = string with type key = string list with type step = string

Store for the log. All store related operations like branching, cloning, merging, etc are done through this module.

type value = V.t

Type of log entry

val append : path:Store.key -> Store.t -> value -> unit Lwt.t

Append an entry to the log

val read_all : path:Store.key -> Store.t -> value list Lwt.t

Read the entire log

type cursor

Type of cursor. Cursor is like a marker from which a certain number of entries can be read

val get_cursor : path:Store.key -> Store.t -> cursor Lwt.t

Create a new cursor over the log entires at the given path

val read : num_items:int -> cursor -> (value list * cursor) Lwt.t

Read at most num_items entries from the cursor. If the number specified is greater than the number of log entries from the cursor, the log is read till the end. If the input cursor has already reached the end, then an empty list is returned

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct