wanderer/ BLAKE3
1
0
Fork 0
mirror of https://github.com/BLAKE3-team/BLAKE3 synced 2024-05-24 18:06:07 +02:00
Code Issues Releases Activity

docs tweaks

This commit is contained in:
Jack O'Connor 2019-12-14 10:12:56 -05:00
parent e6e4e6d687
commit ab88db1aed
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -6,3 +6,6 @@ are provided in Rust, enabled by default, with dynamic CPU feature
detection. AVX-512 and NEON implementation are available via C FFI, detection. AVX-512 and NEON implementation are available via C FFI,
controlled by the `c_avx512` and `c_neon` features. Rayon-based controlled by the `c_avx512` and `c_neon` features. Rayon-based
multi-threading is controlled by the `rayon` feature. multi-threading is controlled by the `rayon` feature.
Eventually docs will be published on docs.rs. For now, you can build and
view the docs locally with `cargo doc --open`.

9
src/lib.rs
View File

@ -19,14 +19,11 @@
//! let hash2 = hasher.finalize(); //! let hash2 = hasher.finalize();
//! assert_eq!(hash1, hash2); //! assert_eq!(hash1, hash2);
//! //!
//! // Extended output. //! // Extended output. OutputReader implements std::io::Read.
//! # #[cfg(feature = "std")] { //! # #[cfg(feature = "std")] {
//! let mut output = Vec::new(); //! let mut output = Vec::new();
//! blake3::Hasher::new() //! let mut output_reader = hasher.finalize_xof();
//! .update(b"foobarbaz") //! output_reader.take(1000).read_to_end(&mut output)?;
//! .finalize_xof()
//! .take(1000)
//! .read_to_end(&mut output)?;
//! assert_eq!(output.len(), 1000); //! assert_eq!(output.len(), 1000);
//! assert_eq!(&output[..32], hash1.as_bytes()); //! assert_eq!(&output[..32], hash1.as_bytes());
//! # } //! # }