Module `Make.Suffix`Source

Abstraction for a chunked suffix. It is functionally equivalent to Append_only_file but with a chunked implementation that is parameterized by

start_idx for create_rw to know the starting file name, and
start_idx and chunk_num for the open functions to know the starting file name and how many files there are.

Sourcemodule Io = Io

Sourcemodule Errs : Io_errors.S

Sourcemodule Ao : Append_only_file.S

Abstraction for irmin-pack's append only files (i.e. suffix and dict).

Sourcetype t

Sourcetype create_error = Io.create_error

Sourcetype open_error = [

| Io.open_error
| `Closed
| `Invalid_argument
| `Inconsistent_store
| `Read_out_of_bounds

]

Sourcetype add_new_error = [

| open_error
| Io.close_error
| `Pending_flush
| `File_exists of string
| `Multiple_empty_chunks

]

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

Sourceval close : t -> (unit, [> Io.close_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

appendable_chunk_poff t is the number of bytes of the chunk file that is currently appendable. It does not perform IO.

RW mode

It also counts the bytes not flushed yet.

RO mode

This information originates from the latest reload of the control file. Calling refresh_appendable_chunk_poff t updates appendable_chunk_poff.

Source

val refresh_appendable_chunk_poff : 
  t ->
  Optint.Int63.t ->
  (unit, [> `Rw_not_allowed ]) result

Ingest the new end offset of the appendable chunk file. Typically happens in RO mode when the control file has been re-read.

RW mode

Always returns Error `Rw_not_allowed.

Sourceval end_soff : t -> Optint.Int63.t

end_soff t is the end offset for the chunked suffix. The valid range of offsets is 0 <= off < end_soff. Therefore, end_soff also represents the length of the chunked suffix.

Sourceval read_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> unit

Source

val read_range_exn : 
  t ->
  off:Optint.Int63.t ->
  min_len:int ->
  max_len:int ->
  bytes ->
  int

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/File_manager/Make/Suffix/index.html

Module `Make.Suffix`Source

package irmin-pack

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Make.SuffixSource

Module `Make.Suffix`Source