package index

  1. Overview
  2. Docs
package index
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t
val v : ?flush_callback:(unit -> unit) -> fresh:bool -> generation:Optint.Int63.t -> fan_size:Optint.Int63.t -> string -> t
val v_readonly : string -> (t, [ `No_file_on_disk ]) result
val offset : t -> Optint.Int63.t
val read : t -> off:Optint.Int63.t -> len:int -> bytes -> int
val clear : generation:Optint.Int63.t -> ?hook:(unit -> unit) -> reopen:bool -> t -> unit
val flush : ?no_callback:unit -> ?with_fsync:bool -> t -> unit
val get_generation : t -> Optint.Int63.t
val set_fanout : t -> string -> unit
val get_fanout : t -> string
val get_fanout_size : t -> Optint.Int63.t
val rename : src:t -> dst:t -> unit
val append : t -> string -> unit
val append_substring : t -> string -> off:int -> len:int -> unit
val close : t -> unit
val size_header : t -> int

size_header t is t's header size.

module Lock : sig ... end
module Header : sig ... end
val exists : string -> bool

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

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