package index

You can search for identifiers within the package.

in-package search v0.2.0

A platform-agnostic multi-level index for OCaml

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (16)

Authors

Maintainers

C

Clement Pascutto

Sources

index-1.4.1.tbz

sha256=dde943f595ee9bb7d9b84cde05d0cb4675097e785dbf833521761fd843252206

sha512=9b4e1e2d684222205a5cb17370acfd90d36026de147d548319b7b411fa0c2c36fce970f3e7604880a38f5a17dfe338efd9e33cd70e51ee3d8cb66b038f2a8a69

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

Module `Private.IO`Source

Sourcetype t

Source

val 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

Source

val 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.