milksad

History

Tobin C. Harding 1d00d47b32 io: Add Changelog Done in preparation for an initial v0.1.0 release of the new `io` crate. Add a changelog file with a brief description of whats in the initial release.		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
CHANGELOG.md	io: Add Changelog	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.