package irmin-pack

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

Parameters

module Io : Io.S
module Errs : Io_errors.S with module Io = Io

Signature

module Io = Io
module Errs = Errs
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.

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