https://github.com/riot-ml/rio
Ergonomic, composable, efficient read/write streams
https://github.com/riot-ml/rio
Last synced: 5 months ago
JSON representation
Ergonomic, composable, efficient read/write streams
- Host: GitHub
- URL: https://github.com/riot-ml/rio
- Owner: riot-ml
- License: other
- Created: 2024-02-26T15:55:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-05T23:47:10.000Z (11 months ago)
- Last Synced: 2025-05-07T20:45:35.259Z (5 months ago)
- Language: OCaml
- Size: 645 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Rio
Ergonomic, composable, efficient read/write streams
Rio is the composable streaming I/O layer on which Riot is built on. It
provides the interfaces to define Readers and Writers for customs sources and
sinks, and it provides functions to glue them together.
It is heavily inspired by Rust's Read and Write traits.
It also provides common instances of Read/Write for Buffer, Bytes, and
Cstruct.
## The Read interface
The Read interface defines how to read bytes from a source.
Implementors of this interface are called 'readers'.
Reader are meant to compose nicely with each other.
Note that each call to `Rio.read reader` may involve a system call.
## The Write interface
The Write interface defines objects that are byte-oriented sinks.
Implementors of this interface are called 'writers'.
Writers are meant to compose nicely with each other.