package index

  1. Overview
  2. Docs
A platform-agnostic multi-level index for OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

index-1.6.1.tbz
sha256=acfc0dcea916a836a4da60d30c806a22f69c858d6f7ce233166c1a5e365e6bee
sha512=78c45c71c1194d6e118c5cf3920d84c571d0f61f8fa3467f72e7c17c4bbab8e01a5efdb6a96a5328a7b3c5bbf01b0b31e42525c66f4be72d986530ef0ec7cec5

doc/index.unix/Index_unix/Private/Raw/index.html

Module Private.RawSource

Raw wraps a file-descriptor with an file-format used internally by Index. The format contains the following header fields:

  • offset: a 64-bit integer, denoting the length of the file containing valid data;
  • version: an 8-byte version string;
  • generation: a 64-bit integer denoting the generation number;
  • fan: a 64-bit length field, followed by a string containing that many bytes.
Sourcetype t

The type of raw file handles.

Construct a raw value from a file descriptor.

Sourceval unsafe_write : t -> off:Optint.Int63.t -> string -> int -> int -> unit
Sourceval unsafe_read : t -> off:Optint.Int63.t -> len:int -> bytes -> int
Sourceval fsync : t -> unit
Sourceval close : t -> unit
Sourceval fstat : t -> Unix.stats
Sourceexception Not_written
Sourcemodule Version : sig ... end
Sourcemodule Offset : sig ... end
Sourcemodule Generation : sig ... end
Sourcemodule Fan : sig ... end
Sourcemodule Header : sig ... end
Sourcemodule Header_prefix : sig ... end

Functions for interacting with the header format without the generation number, provided for use in irmin-pack.

OCaml

Innovation. Community. Security.