Construct a safe wrapper around B where necessary buffer preconditions are checked on read and write, and useful error messages generated. Some concrete implementations generate confusing errors (e.g. Unix might say "EINVAL") which are harder to debug.
module B : SThe type for write errors.
include S
with type t = B.t
and type error := error
and type write_error := write_errorval pp_error : error Fmt.tval pp_write_error : write_error Fmt.tval read :
t ->
int64 ->
page_aligned_buffer list ->
(unit, error) Stdlib.result ioval write :
t ->
int64 ->
page_aligned_buffer list ->
(unit, write_error) Stdlib.result ioval unsafe_read :
t ->
int64 ->
page_aligned_buffer list ->
(unit, B.error) Result.result Lwt.tunsafe_read is like read except it bypasses the necessary buffer precondition checks. Only use this if you want maximum performance and if you can prove the preconditions are respected.
val unsafe_write :
t ->
int64 ->
page_aligned_buffer list ->
(unit, B.write_error) Result.result Lwt.tunsafe_write is like write except it bypasses the necessary buffer precondition checks. Only use this if you want maximum performance and if you can prove the buffer preconditions are respected.