rust-bitcoin-unsafe-fast/io
Tobin C. Harding d480adaf25
io: Simplify crate docs and add README
Simplify the docs in `lib.rs` and copy them into a minimal README file.
2024-01-06 08:22:36 +11:00
..
src io: Simplify crate docs and add README 2024-01-06 08:22:36 +11:00
Cargo.toml io: Make crate MSRV 1.56.1 2023-12-13 14:22:01 +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.