package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Io : sig ... end
module Errs : sig ... end
module Ao : sig ... end
type t
type create_error = Io.create_error
type 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
]
type 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
]
val create_rw : root:string -> start_idx:int -> overwrite:bool -> auto_flush_threshold:int -> auto_flush_procedure:Ao.auto_flush_procedure -> (t, [> create_error ]) Stdlib.result
val 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 ]) Stdlib.result
val open_ro : root:string -> appendable_chunk_poff:Optint.Int63.t -> dead_header_size:int -> start_idx:int -> chunk_num:int -> (t, [> open_error ]) Stdlib.result
val add_chunk : auto_flush_threshold:int -> auto_flush_procedure:Ao.auto_flush_procedure -> t -> (unit, [> add_new_error ]) Stdlib.result
val start_idx : t -> int
val chunk_num : t -> int
val close : t -> (unit, [> `Double_close | `Io_misc of Io.misc_error | `Pending_flush ]) Stdlib.result
val empty_buffer : t -> bool
val flush : t -> (unit, [> Io.write_error ]) Stdlib.result
val fsync : t -> (unit, [> Io.write_error ]) Stdlib.result
val appendable_chunk_poff : t -> Optint.Int63.t
val refresh_appendable_chunk_poff : t -> Optint.Int63.t -> (unit, [> `Rw_not_allowed ]) Stdlib.result
val end_soff : t -> Optint.Int63.t
val read_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> unit
val append_exn : t -> string -> unit
val readonly : t -> bool
val auto_flush_threshold : t -> int option
val 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