package index

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

Install

Dune Dependency

Authors

Maintainers

Sources

index-1.3.1.tbz
sha256=c9c662fd314ba06465a12a6362a1f91421d63f77b28930880cb112127e629ee2
sha512=db22d6f986f9ea92c2b6c677c956cdbb8cab4cec57e2828f13560ebe6167a08d1f33332cf8a1a2cdc72cea77a3786d43365181d3fc0a90572fce6212f242836a

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

Module Private.IOSource

Sourcetype t
Sourceval v : ?flush_callback:(unit -> unit) -> fresh:bool -> generation:int64 -> fan_size:int64 -> string -> t
Sourceval v_readonly : string -> (t, [ `No_file_on_disk ]) result
Sourceval offset : t -> int64
Sourceval read : t -> off:int64 -> len:int -> bytes -> int
Sourceval clear : generation:int64 -> ?hook:(unit -> unit) -> reopen:bool -> t -> unit
Sourceval flush : ?no_callback:unit -> ?with_fsync:bool -> t -> unit
Sourceval get_generation : t -> int64
Sourceval set_fanout : t -> string -> unit
Sourceval get_fanout : t -> string
Sourceval rename : src:t -> dst:t -> unit
Sourceval append : t -> string -> 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.