package irmin-pack

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

Module Make.ControlSource

Abstraction for an irmin-pack control file.

It is parameterized with Io, a file system abstraction (e.g. unix, mirage, eio_linux).

None of the functions raise exceptions.

Sourcemodule Io = Io
Sourcetype t
Sourceval create_rw : path:string -> tmp_path:string option -> overwrite:bool -> Irmin_pack_unix__.Control_file_intf.Payload.Upper.V5.t -> (t, [> Io.create_error | Io.write_error ]) result

Create a rw instance of t by creating a control file.

Sourceval open_ : path:string -> tmp_path:string option -> readonly:bool -> (t, [> `Corrupted_control_file of string | `Io_misc of Io.misc_error | `No_such_file_or_directory of string | `Not_a_file | `Closed | `Unknown_major_pack_version of string ]) result

Create a rw instance of t by reading an existing file at path. tmp_path will be used by RW instances when updating it's content, it is not required for RO instances or RW instances which will never be updated.

Sourceval close : t -> (unit, [> Io.close_error ]) result
Sourceval read_payload : path:string -> (Irmin_pack_unix__.Control_file_intf.Payload.Upper.V5.t, [> `Corrupted_control_file of string | `Io_misc of Io.misc_error | `No_such_file_or_directory of string | `Not_a_file | `Closed | `Unknown_major_pack_version of string | Io.close_error ]) result

read_payload ~path reads the payload at path. It is a convenient way to read the payload without needing to call open_, payload, close.

Sourceval read_raw_payload : path:string -> (Irmin_pack_unix__.Control_file_intf.Payload.Upper.raw_payload, [> `Corrupted_control_file of string | `Io_misc of Io.misc_error | `No_such_file_or_directory of string | `Not_a_file | `Closed | `Unknown_major_pack_version of string | Io.close_error ]) result
Sourceval payload : t -> Irmin_pack_unix__.Control_file_intf.Payload.Upper.V5.t

payload t is the payload in t.

That function doesn't perform IO.

RW mode

payload t is the payload, as it was written to the file system.

RO mode

payload t is the payload, as it was seen during open_ or during the most recent reload.

Sourceval reload : t -> (unit, [> `Rw_not_allowed | `Corrupted_control_file of string | `Io_misc of Io.misc_error | `No_such_file_or_directory of string | `Not_a_file | `Closed | `Unknown_major_pack_version of string | Io.close_error ]) result

RW mode

Always returns an error.

RO mode

Reread the file on disk.

If the file changed since the last read, the payload in t is updated to match the content of the file.

Sourceval set_payload : t -> Irmin_pack_unix__.Control_file_intf.Payload.Upper.V5.t -> (unit, [> `No_tmp_path_provided | Io.create_error | Io.write_error | `Sys_error of string | Io.close_error ]) result

RW mode

Write a new payload on disk.

RO mode

Always returns an error.

Sourceval readonly : t -> bool
Sourceval fsync : t -> (unit, [> Io.write_error ]) result

RW mode

Tell the OS to fush its internal buffers.

RO mode

Always returns Error `Ro_not_allowed.