package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=535254ca443858bfc9e540535977fed63e9206d4b78c5cac0239d1e6657b5c78
sha512=fa18557fcf808121a0495de707c6f7bff4a69197b310480816648adafd4a659b5673a1f5bbf4574f517b7d93253735ef7798b0c365d87afac60675007ef19b54
doc/irmin-pack.unix/Irmin_pack_unix/File_manager/Make/argument-1-Control/index.html
Parameter Make.Control
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.
module Io = Io.Unixval 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| `Read_on_closed| `Unknown_major_pack_version of string
]val open_ : path:string -> readonly:bool -> (t, [> open_error ]) resultCreate a rw instance of t by reading an existing file at path.
val close : t -> (unit, [> Io.close_error ]) resultval payload : t -> Irmin_pack_unix__.Control_file_intf.Payload_v3.tpayload 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| `Read_on_closed| `Rw_not_allowed| `Unknown_major_pack_version of string
]val reload : t -> (unit, [> reload_error ]) resultRW 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.
val readonly : t -> boolval fsync : t -> (unit, [> Io.write_error ]) resultRW mode
Tell the os to fush its internal buffers.
RO mode
Always returns Error `Ro_not_allowed.