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/IO/index.html

Module Private.IOSource

Sourcetype t
Sourceval v : ?flush_callback:(unit -> unit) -> fresh:bool -> generation:Optint.Int63.t -> fan_size:Optint.Int63.t -> string -> t
Sourceval v_readonly : string -> (t, [ `No_file_on_disk ]) result
Sourceval offset : t -> Optint.Int63.t
Sourceval read : t -> off:Optint.Int63.t -> len:int -> bytes -> int
Sourceval clear : generation:Optint.Int63.t -> ?hook:(unit -> unit) -> reopen:bool -> t -> unit
Sourceval flush : ?no_callback:unit -> ?with_fsync:bool -> t -> unit
Sourceval get_generation : t -> Optint.Int63.t
Sourceval set_fanout : t -> string -> unit
Sourceval get_fanout : t -> string
Sourceval get_fanout_size : t -> Optint.Int63.t
Sourceval rename : src:t -> dst:t -> unit
Sourceval append : t -> string -> unit
Sourceval append_substring : t -> string -> off:int -> len:int -> unit
Sourceval close : t -> unit
Sourceval size_header : t -> int

size_header t is t's header size.

Sourcemodule Lock : sig ... end
Sourcemodule Header : sig ... end
Sourceval exists : string -> bool

exists name is true iff there is a pre-existing IO instance called name.

Sourceval size : t -> int

Returns the true size of the underlying data representation in bytes. Note that this is not necessarily equal to the total size of observable data, which is given by offset.

To be used for debugging purposes only.

OCaml

Innovation. Community. Security.