package index

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

Install

Dune Dependency

Authors

Maintainers

Sources

index-1.3.2.tbz
sha256=0e46ebc785eb5b947bcb6e04075dda694d7e951c5ac51103e4d5fa5105df5d14
sha512=fd82ba852bb43eae8fefca2563d114bc2fa99e0ba98c828bccc2e81737a05156297b64b5894e2d0a58457a3382730a34e16cf16c844f8a6e6844c2684d79c7b5

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.