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

bitcoin: Update feature docs 

The `bitcoin` crate documents its features in the crate level rustdocs,
currently they are stale.

Update and improve the feature docs section of crate level docs.
This commit is contained in:
Tobin C. Harding 2024-06-19 11:36:14 +10:00
parent 7712e5d891
commit c6c70a721e
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
bitcoin/src/lib.rs
View File

@ -11,21 +11,21 @@
//! //!
//! See README.md for detailed documentation about development and supported environments. //! See README.md for detailed documentation about development and supported environments.
//! //!
//! ## Available feature flags //! # Cargo features
//! //!
//! * `std` - the usual dependency on `std` (default). //! * `base64` (dependency) - enables encoding of PSBTs and message signatures.
//! * `secp-recovery` - enables calculating public key from a signature and message. //! * `bitcoinconsensus` (dependency) - enables validating scripts and transactions.
//! * `base64` - (dependency), enables encoding of PSBTs and message signatures. //! * `bitcoinconsensus-std` - same as `bitcoinconsensus` but also enables `std` here and in the
//! * `rand` - (dependency), makes it more convenient to generate random values. //! `bitcoinconsensus` crate. Additionally, enables returning
//! * `serde` - (dependency), implements `serde`-based serialization and //! `bitcoinconsensus::Error` from `std::error::Error::source()`.
//! deserialization. //! * `default` - enables `std` and `secp-recovery`.
//! * `ordered` (dependency) - adds implementations of `ArbitraryOrd` to some structs.
//! * `rand` (transitive dependency) - makes it more convenient to generate random values.
//! * `rand-std` - same as `rand` but also enables `std` here and in `secp256k1`.
//! * `serde` (dependency) - implements `serde`-based serialization and deserialization.
//! * `secp-lowmemory` - optimizations for low-memory devices. //! * `secp-lowmemory` - optimizations for low-memory devices.
//! * `bitcoinconsensus-std` - enables `std` in `bitcoinconsensus` and communicates it //! * `secp-recovery` - enables calculating public key from a signature and message.
//! to this crate so it knows how to implement //! * `std` - the usual dependency on `std`.
//! `std::error::Error`. At this time there's a hack to
//! achieve the same without this feature but it could
//! happen the implementations diverge one day.
//! * `ordered` - (dependency), adds implementations of `ArbitraryOrdOrd` to some structs.
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)] #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
// Experimental features we need. // Experimental features we need.