package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Fm.SuffixSource

Sourcemodule Io : sig ... end
Sourcemodule Errs : sig ... end
Sourcemodule Ao : sig ... end
Sourcetype create_error = Io.create_error
Sourcetype open_error = [
  1. | `Closed
  2. | `Inconsistent_store
  3. | `Invalid_argument
  4. | `Io_misc of Io.misc_error
  5. | `No_such_file_or_directory
  6. | `Not_a_file
  7. | `Read_out_of_bounds
]
Sourcetype add_new_error = [
  1. | `Closed
  2. | `Double_close
  3. | `File_exists of string
  4. | `Inconsistent_store
  5. | `Invalid_argument
  6. | `Io_misc of Io.misc_error
  7. | `Multiple_empty_chunks
  8. | `No_such_file_or_directory
  9. | `Not_a_file
  10. | `Pending_flush
  11. | `Read_out_of_bounds
]
Sourceval create_rw : root:string -> start_idx:int -> overwrite:bool -> auto_flush_threshold:int -> auto_flush_procedure:Ao.auto_flush_procedure -> (t, [> create_error ]) result
Sourceval open_rw : root:string -> appendable_chunk_poff:Optint.Int63.t -> start_idx:int -> chunk_num:int -> dead_header_size:int -> auto_flush_threshold:int -> auto_flush_procedure:Ao.auto_flush_procedure -> (t, [> open_error ]) result
Sourceval open_ro : root:string -> appendable_chunk_poff:Optint.Int63.t -> dead_header_size:int -> start_idx:int -> chunk_num:int -> (t, [> open_error ]) result
Sourceval add_chunk : auto_flush_threshold:int -> auto_flush_procedure:Ao.auto_flush_procedure -> t -> (unit, [> add_new_error ]) result
Sourceval start_idx : t -> int
Sourceval chunk_num : t -> int
Sourceval close : t -> (unit, [> `Double_close | `Io_misc of Io.misc_error | `Pending_flush ]) result
Sourceval empty_buffer : t -> bool
Sourceval flush : t -> (unit, [> Io.write_error ]) result
Sourceval fsync : t -> (unit, [> Io.write_error ]) result
Sourceval appendable_chunk_poff : t -> Optint.Int63.t
Sourceval refresh_appendable_chunk_poff : t -> Optint.Int63.t -> (unit, [> `Rw_not_allowed ]) result
Sourceval end_soff : t -> Optint.Int63.t
Sourceval read_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> unit
Sourceval append_exn : t -> string -> unit
Sourceval readonly : t -> bool
Sourceval auto_flush_threshold : t -> int option
Sourceval fold_chunks : (acc:'a -> idx:int -> start_suffix_off:Optint.Int63.t -> end_suffix_off:Optint.Int63.t -> is_appendable:bool -> 'a) -> 'a -> t -> 'a
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct