milksad

History

Tobin C. Harding 83397c465c io: Add documentation to all public types and functions Add docs for all public types and add a lint to enforce this going forwards. Use `allow` attribute in macro, will be fixed as a subsequent patch.		2024-02-05 11:58:10 +11:00
..
contrib	CI: Epic overhaul	2024-02-02 05:57:23 +11:00
src	io: Add documentation to all public types and functions	2024-02-05 11:58:10 +11:00
Cargo.toml	io: Enable alloc from std	2024-01-31 11:32:46 +11:00
README.md	io: Simplify crate docs and add README	2024-01-06 08:22:36 +11:00

README.md

Rust-Bitcoin IO Library

The std::io module is not exposed in no-std Rust so building no-std applications which require reading and writing objects via standard traits is not generally possible. Thus, this library exists to export a minmal version of std::io's traits which we use in rust-bitcoin so that we can support no-std applications.

These traits are not one-for-one drop-ins, but are as close as possible while still implementing std::io's traits without unnecessary complexity.