Skip to content

Commit

Permalink
Merge pull request #1079 from JJPennington/master
Browse files Browse the repository at this point in the history
Modified the StdRng documentation
  • Loading branch information
dhardy authored Dec 18, 2020
2 parents 34423a6 + 9aa8bc1 commit cc93dae
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/rngs/std.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,17 @@ pub(crate) use rand_hc::Hc128Core as Core;
/// on the current platform, to be statistically strong and unpredictable
/// (meaning a cryptographically secure PRNG).
///
/// The current algorithm used is the ChaCha block cipher with 20 rounds.
/// This may change as new evidence of cipher security and performance
/// becomes available.
/// The current algorithm used is the ChaCha block cipher with 12 rounds. Please
/// see this relevant [rand issue] for the discussion. This may change as new
/// evidence of cipher security and performance becomes available.
///
/// The algorithm is deterministic but should not be considered reproducible
/// due to dependence on configuration and possible replacement in future
/// library versions. For a secure reproducible generator, we recommend use of
/// the [rand_chacha] crate directly.
///
/// [rand_chacha]: https://crates.io/crates/rand_chacha
/// [rand issue]: https://github.com/rust-random/rand/issues/932
#[cfg_attr(doc_cfg, doc(cfg(feature = "std_rng")))]
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct StdRng(Rng);
Expand Down

0 comments on commit cc93dae

Please sign in to comment.