aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2025-04-24 09:32:50 -0700
committerJack O'Connor <[email protected]>2025-04-24 09:44:38 -0700
commitf3e0184aaba8284bbab2ce434dd7ed337d3fbe05 (patch)
tree434abcd87b2a62e6cf649d7bc729b80415e4bfdf /src
parented3fd0da1d049ab531bcd358630da02ece504464 (diff)
update docs for the "std" feature
Previously "std" enabled runtime CPU feature detection on x86, but as of https://github.com/BLAKE3-team/BLAKE3/pull/469 that's always on.
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs12
1 files changed, 5 insertions, 7 deletions
diff --git a/src/lib.rs b/src/lib.rs
index d777896..280964b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -32,13 +32,10 @@
//!
//! # Cargo Features
//!
-//! The `std` feature (the only feature enabled by default) is required for
-//! implementations of the [`Write`] and [`Seek`] traits, the
-//! [`update_reader`](Hasher::update_reader) helper method, and runtime CPU
-//! feature detection on x86. If this feature is disabled, the only way to use
-//! the x86 SIMD implementations is to enable the corresponding instruction sets
-//! globally, with e.g. `RUSTFLAGS="-C target-cpu=native"`. The resulting binary
-//! will not be portable to other machines.
+//! The `std` feature (the only feature enabled by default) enables the
+//! [`Write`] implementation and the [`update_reader`](Hasher::update_reader)
+//! method for [`Hasher`], and also the [`Read`] and [`Seek`] implementations
+//! for [`OutputReader`].
//!
//! The `rayon` feature (disabled by default, but enabled for [docs.rs]) adds
//! the [`update_rayon`](Hasher::update_rayon) and (in combination with `mmap`
@@ -82,6 +79,7 @@
//! [BLAKE3]: https://blake3.io
//! [Rayon]: https://github.com/rayon-rs/rayon
//! [docs.rs]: https://docs.rs/
+//! [`Read`]: https://doc.rust-lang.org/std/io/trait.Read.html
//! [`Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
//! [`Seek`]: https://doc.rust-lang.org/std/io/trait.Seek.html
//! [`digest`]: https://crates.io/crates/digest