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.7.2.tbz
sha256=6aa5ba4c6a0233747d4bd3ab396f2b3a33bb80f9d8ed4a178c83a035033c0e52
sha512=8a5506a57e8569a11c883ca25b3c60ae7a9a03c2da111668193d7b4296434c43f1a310e78f189e4b38c234da790259d2961c6a0ae481282c18bb97f618fccfb6

doc/irmin-pack.unix/Irmin_pack_unix/Lower/Make_volume/Sparse/index.html

Module Make_volume.SparseSource

module Io : Io.S

Low level IO abstraction. A typical implementation is unix. This abstraction is meant to be dead simple. Not a lot of documentation is required.

Sourcemodule Errs : Io_errors.S with module Io = Io
Sourcetype t
type open_error := [
  1. | Io.open_error
  2. | `Corrupted_mapping_file of string
]
Sourceval open_ro : mapping_size:int -> mapping:string -> data:string -> (t, [> open_error ]) result

open_ro ~mapping_size ~mapping ~data returns a new read-only view of the sparse file, represented on disk by two files named mapping and data. The mapping file is expected to have size at least mapping_size (and the rest is ignored if the file is larger).

Sourceval close : t -> (unit, [> Io.close_error ]) result

Close the underlying files.

Sourceval read_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> unit

read_exn t ~off ~len buffer writes into buffer the bytes from off to off+len.

Sourceval read_range_exn : t -> off:Optint.Int63.t -> min_len:int -> max_len:int -> bytes -> int

Same as read_exn, the amount read is max_len if possible or at least min_len if reading more would step over a hole in the sparse file.

Returns the actually read length.

Sourceval next_valid_offset : t -> off:Optint.Int63.t -> Optint.Int63.t option

next_valid_offset t ~off returns Some off' such that off' is the smallest readable offset larger or equal to off. This enables jumping over a sparse hole to the next compact range of data.

Sourceval iter : t -> (off:Optint.Int63.t -> len:int -> unit) -> (unit, Errs.t) result

iter t f calls f on each (off,len) pair in mapping. Only used for testing and debugging.

It is guaranteed for the offsets to be iterated in monotonic order.

It is guaranteed that entries don't overlap.

The exceptions raised by f are caught and returned (as long as they are known by Errs).

Sourcemodule Wo : sig ... end
Sourcemodule Ao : sig ... end