Module `File_manager.Suffix`Source

Sourcemodule Io : sig ... end

Sourcemodule Errs : sig ... end

Sourcemodule Ao : sig ... end

Sourcetype t

Sourcetype create_error = Io.create_error

Sourcetype open_error = [

| `Closed
| `Inconsistent_store
| `Invalid_argument
| `Io_misc of Io.misc_error
| `No_such_file_or_directory
| `Not_a_file
| `Read_out_of_bounds

]

Sourcetype add_new_error = [

| `Closed
| `Double_close
| `File_exists of string
| `Inconsistent_store
| `Invalid_argument
| `Io_misc of Io.misc_error
| `Multiple_empty_chunks
| `No_such_file_or_directory
| `Not_a_file
| `Pending_flush
| `Read_out_of_bounds

]

Source

val create_rw : 
  root:string ->
  start_idx:int ->
  overwrite:bool ->
  auto_flush_threshold:int ->
  auto_flush_procedure:Ao.auto_flush_procedure ->
  (t, [> create_error ]) result

Source

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 ]) result

Source

val open_ro : 
  root:string ->
  appendable_chunk_poff:Optint.Int63.t ->
  dead_header_size:int ->
  start_idx:int ->
  chunk_num:int ->
  (t, [> open_error ]) result

Source

val 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

Source

val 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

Source

val 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

Source

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

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/KV/Maker/Make/File_manager/Suffix/index.html

Module `File_manager.Suffix`Source

package irmin-pack

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/KV/Maker/Make/File_manager/Suffix/index.html

Module File_manager.SuffixSource

Module `File_manager.Suffix`Source