package index

  1. Overview
  2. Docs
package index
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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.

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