package irmin-pack

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

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

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

doc/irmin-pack.unix/Irmin_pack_unix/Dispatcher/Make/argument-1-Fm/Lower/Volume/index.html

Module Lower.Volume

module Io = Io
module Errs : Io_errors.S
type t
type open_error = [
  1. | Io.open_error
  2. | `Closed
  3. | `Double_close
  4. | `Corrupted_control_file of string
  5. | `Unknown_major_pack_version of string
]
val v : string -> (t, [> open_error ]) result

v path loads the volume at path in read-only.

val path : t -> string

path t is the directory that contains the volume.

val is_empty : t -> bool

is_empty t returns whether t is empty or not.

val control : t -> Control_file.Payload.Volume.Latest.t option

control t returns the control file payload for the volume.

val identifier : t -> string

identifier t is a unique idendifier for the volume.