package index

You can search for identifiers within the package.

in-package search v0.2.0

index
- Index
  - Cache
    
    Noop
    
    S
    
    Unbounded
  - Checks
    
    Make
    
    Integrity_check
    
    K
    
    Stat
    
    V
    
    _
    
    Clock
    
    IO
    
    Header
    
    Lock
    
    Platform_args
    
    Clock
    
    IO
    
    Header
    
    Lock
    
    S
    
    Integrity_check
    
    Stat
  - Key
    
    S
    
    String_fixed
    
    L
  - Make
    
    C
    
    Checks
    
    Integrity_check
    
    Stat
    
    K
    
    V
    
    _
    
    Clock
    
    IO
    
    Header
    
    Lock
    
    Semaphore
    
    Thread
  - Platform
    
    CLOCK
    
    IO
    
    Header
    
    Lock
    
    S
    
    Clock
    
    IO
    
    Header
    
    Lock
    
    Semaphore
    
    Thread
    
    SEMAPHORE
    
    THREAD
  - Private
    
    Data
    
    Entry
    
    Make
    
    K
    
    V
    
    S
    
    Key
    
    String_fixed
    
    L
    
    Value
    
    Fan
    
    Hook
    
    Io
    
    Extend
    
    Header
    
    Lock
    
    S
    
    Header
    
    Lock
    
    S
    
    Header
    
    Lock
    
    Io_array
    
    ELT
    
    Make
    
    Elt
    
    IO
    
    Header
    
    Lock
    
    S
    
    Layout
    
    Logs
    
    Make
    
    C
    
    Checks
    
    Integrity_check
    
    Stat
    
    K
    
    V
    
    _
    
    Clock
    
    IO
    
    Header
    
    Lock
    
    Semaphore
    
    Thread
    
    S
    
    Checks
    
    Integrity_check
    
    Stat
    
    Search
    
    ARRAY
    
    ENTRY
    
    Key
    
    Value
    
    METRIC
    
    Entry
    
    Key
    
    Value
    
    Make
    
    Array
    
    Entry
    
    Key
    
    Value
    
    Metric
    
    S
    
    Array
    
    Entry
    
    Key
    
    Value
  - S
    
    Checks
    
    Integrity_check
    
    Stat
  - Stats
    
    Make
    
    _
  - Value
    
    S
    
    String_fixed
    
    L
index.unix
- Index_unix
  - Make
    
    C
    
    Checks
    
    Integrity_check
    
    Stat
    
    K
    
    V
  - Private
    
    IO
    
    Header
    
    Lock
    
    Make
    
    C
    
    Checks
    
    Integrity_check
    
    Stat
    
    K
    
    V
    
    Raw
    
    Fan
    
    Generation
    
    Header
    
    Header_prefix
    
    Offset
    
    Version
  - Syscalls

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.