package irmin-pack

You can search for identifiers within the package.

in-package search v0.2.0

Irmin backend which stores values in a pack file

Install

Dune Dependency

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

Authors

T

Thomas Gazagnaire

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.4.0.tbz

sha256=9e72efdc13324602d8da46e0492b1f4e09ad524149845e1a9106882f60ad6e1f

sha512=ae9cb4b086c7b93962aafc2ea339ac85c6d66bdf769f70a16f62fa5c74d9b194e12ac00b510be5ffac5adff3aa20fd69c4ca4067dcc966767fefcf5c02bc9969

doc/irmin-pack.unix/Irmin_pack_unix/Pack_store/Make/argument-3-Dispatcher/index.html

Parameter `Make.Dispatcher`

module Fm = Fm

module Mapping_file : Mapping_file.S with module Io = Fm.Io

type t

val v : root:string -> Fm.t -> (t, [> Fm.Errs.t ]) result

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

read_exn either reads in the prefix or the suffix file, depending on off. See Io.read_exn for the arguments. If it tries to read a gced object, an exception is raised.

val read_at_most_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> int

read_at_most_exn is similar to read_exn but if the end of file is reached while reading len bytes, then only the available bytes are read. No `Read_out_of_bounds error is raised. The number of bytes read are returned.

val end_offset : t -> Optint.Int63.t

end_offset is the end offsets of the pack entries, counting that the prefix doesn't start at 0. It counts the entries not yet flushed from the prefix.

val read_if_not_gced : t -> off:Optint.Int63.t -> len:int -> bytes -> bool

Similar to read_exn but returns false if the object was gced, instead of raising an expection.

val offset_of_suffix_off : t -> Optint.Int63.t -> Optint.Int63.t

offset_of_suffix_off t suffix_off converts a suffix offset into a (global) offset.

val read_in_prefix_and_suffix_exn : 
  t ->
  off:Optint.Int63.t ->
  len:int ->
  bytes ->
  unit

Simlar to read_exn but if off + len is greater than the end of the prefix, it will read the remaining in the prefix.