Block device abstraction for OCaml 5 with Eio direct-style I/O and Bytesrw integration
fix(lint): resolve E410 doc style and E415 missing pp across packages
Fix 64 documentation style issues: add trailing periods, fix [name] format
mismatches, and correct arg count mismatches in doc comments. Add pp
pretty-printers to 7 modules (block_map, standard_site_api, tangled_api,
xrpc_auth_client, xrpc_client, xrpc_cred, block).
+13
+6
lib/block.ml
+6
lib/block.ml
···
29
29
30
30
type t = T : { state : 'a; impl : (module IMPL with type state = 'a) } -> t
31
31
32
+
let pp ppf (T { state; impl = (module I) }) =
33
+
let i = I.info state in
34
+
Fmt.pf ppf "<block %s sectors=%Ld sector-size=%d>"
35
+
(if i.read_write then "rw" else "ro")
36
+
i.sectors i.sector_size
37
+
32
38
let info (T { state; impl = (module I) }) = I.info state
33
39
let read (T { state; impl = (module I) }) sector = I.read state sector
34
40
+7
lib/block.mli
+7
lib/block.mli
···
36
36
type t
37
37
(** A block device handle. *)
38
38
39
+
val pp : t Fmt.t
40
+
(** [pp] pretty-prints the block device, showing sector size, sector count, and
41
+
read/write mode. *)
42
+
39
43
type error =
40
44
[ `Disconnected (** Device has been disconnected *)
41
45
| `Read_error of string (** Read operation failed *)
···
49
53
(** Write errors. *)
50
54
51
55
val pp_error : error Fmt.t
56
+
(** Pretty-print a read error. *)
57
+
52
58
val pp_write_error : write_error Fmt.t
59
+
(** Pretty-print a write error. *)
53
60
54
61
(** {1 Device Operations} *)
55
62