71fab82a1b
Note that the docsrs build enables all features so the `impl_write` macro gets a `std` feature flag even though it is available without the `std` feature enabled. I can't think of a solution to that slight annoyance ATM. The current docs on `impl_write` seem to be stale. The macro just does a simple call through implementation of `crate::Write` and the same for `std::io::Write` if `std` is enabled. Improve the rusdocs by doing: - Remove module level docs because this is a private module and they only add minimal value. - Put the docs on the `std` macro only (docs build uses --all-features) - Explain just what the macro does and include an `# Arguments` section. |
||
|---|---|---|
| .. | ||
| contrib | ||
| src | ||
| tests | ||
| CHANGELOG.md | ||
| Cargo.toml | ||
| README.md | ||
README.md
Rust-Bitcoin I/O 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 minimal 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.