package irmin-containers

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

Module Linked_log.FSSource

Linked log instantiated using the FS backend provided by Irmin_fs_unix, timestamp method Time.Unix and hash Irmin.Hash.SHA1

Parameters

module C : sig ... end
module V : Irmin.Type.S

Signature

module Store : Irmin.KV

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

Sourcetype value = V.t

Type of log entry

Sourceval append : path:Store.path -> Store.t -> value -> unit Lwt.t

Append an entry to the log

Sourceval read_all : path:Store.path -> Store.t -> value list Lwt.t

Read the entire log

Sourcetype cursor

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

Sourceval get_cursor : path:Store.path -> Store.t -> cursor Lwt.t

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

Sourceval 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