milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

io: Simplify crate docs and add README 

Simplify the docs in `lib.rs` and copy them into a minimal README file.
This commit is contained in:
Tobin C. Harding 2023-12-06 11:09:18 +11:00
parent 9ea3e29d61
commit d480adaf25
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
2 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
io/README.md Normal file
View File

@ -0,0 +1,10 @@
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.

15
io/src/lib.rs
View File

@ -1,16 +1,11 @@
//! Rust-Bitcoin IO Library //! Rust-Bitcoin IO Library
//! //!
//! Because the core `std::io` module is not yet exposed in `no-std` Rust, building `no-std` //! The `std::io` module is not exposed in `no-std` Rust so building `no-std` applications which
//! applications which require reading and writing objects via standard traits is not generally //! require reading and writing objects via standard traits is not generally possible. Thus, this
//! possible. While there is ongoing work to improve this situation, this module is not likely to //! library exists to export a minmal version of `std::io`'s traits which we use in `rust-bitcoin`
//! be available for applications with broad rustc version support for some time. //! so that we can support `no-std` applications.
//! //!
//! Thus, this library exists to export a minmal version of `std::io`'s traits which `no-std` //! These traits are not one-for-one drop-ins, but are as close as possible while still implementing
//! applications may need. With the `std` feature, these traits are also implemented for the
//! `std::io` traits, allowing standard objects to be used wherever the traits from this crate are
//! required.
//!
//! This traits are not one-for-one drop-ins, but are as close as possible while still implementing
//! `std::io`'s traits without unnecessary complexity. //! `std::io`'s traits without unnecessary complexity.
#![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(not(feature = "std"), no_std)]