package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=6e430cf44aee5ffdc94f6bfad8dbc401e3ea036ed1fbcf2a8697198ecbf6d412
sha512=b969d0913f0776384fafc4f138cb5187a921e827fd9940d0b350601e1913bdecdfc5acc62ec0ff7c6906e230950a68b39bd886ba3fe37be52e1c6117ddce1791
doc/irmin-pack.unix/Irmin_pack_unix/Control_file/Make/index.html
Module Control_file.MakeSource
Abstraction for irmin-pack's control file.
It is parameterized with Io, a file system abstraction (e.g. unix, mirage, eio_linux).
None of the functions raise exceptions.
Parameters
Signature
val create_rw :
path:string ->
overwrite:bool ->
Irmin_pack_unix__.Control_file_intf.Payload_v3.t ->
(t, [> Io.create_error | Io.write_error ]) resultCreate a rw instance of t by creating a control file.
type open_error := [ | `Corrupted_control_file| `Io_misc of Io.misc_error| `No_such_file_or_directory| `Not_a_file| `Closed| `Unknown_major_pack_version of string
]Create a rw instance of t by reading an existing file at path.
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.
type reload_error := [ | `Corrupted_control_file| `Io_misc of Io.misc_error| `Closed| `Rw_not_allowed| `Unknown_major_pack_version of string
]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.
val set_payload :
t ->
Irmin_pack_unix__.Control_file_intf.Payload_v3.t ->
(unit, [> Io.write_error ]) resultRW mode
Write a new payload on disk.
RO mode
Always returns an error.
RW mode
Tell the OS to fush its internal buffers.
RO mode
Always returns Error `Ro_not_allowed.