package index

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

Install

Dune Dependency

Authors

Maintainers

Sources

index-1.6.2.tbz
sha256=9388835098a4ed44eeced070ed86855c049df12a98311d4980b9b724ecab8860
sha512=2e3052aac2a3ee4190e5cbc914d37904d589997463b22023d31e6b75e21d779342088324a9b42d1854bf7131f32f3e75f6f9cc2cb214d79dd2baa0b4cc2eaad3

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.