Bytesrw adapter for Eio
anil.recoil.org
ocaml
codec
1# bytesrw-eio - OCaml Bytesrw adapters for Eio
2
3This OCaml library provides adapters to create `Bytesrw.Bytes.Reader.t` and
4`Bytesrw.Bytes.Writer.t` from Eio flows, mirroring the API of `Bytesrw_unix`
5for Eio's effect-based I/O.
6
7## Usage
8
9```ocaml
10open Eio.Std
11
12(* Create a reader from an Eio flow *)
13let read_from_flow flow =
14 let reader = Bytesrw_eio.bytes_reader_of_flow flow in
15 (* Use reader with Bytesrw decoders *)
16 reader
17
18(* Create a writer to an Eio flow *)
19let write_to_flow flow =
20 let writer = Bytesrw_eio.bytes_writer_of_flow flow in
21 (* Use writer with Bytesrw encoders *)
22 writer
23```
24
25For custom slice sizes:
26
27```ocaml
28(* Specify custom slice length for reading *)
29let reader = Bytesrw_eio.bytes_reader_of_flow ~slice_length:4096 flow in
30
31(* Specify custom slice length for writing *)
32let writer = Bytesrw_eio.bytes_writer_of_flow ~slice_length:4096 flow in
33()
34```
35
36## Installation
37
38```
39opam install bytesrw-eio
40```
41
42## Documentation
43
44API documentation is available via:
45
46```
47opam install bytesrw-eio
48odig doc bytesrw-eio
49```
50
51## License
52
53ISC