Skip to content

Commit 4b8b686

Browse files
committed
Document new error-handling behaviour for ReseedingRng
1 parent 6c25c6d commit 4b8b686

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

src/rngs/reseeding.rs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,11 @@ use rand_core::{CryptoRng, RngCore, SeedableRng, TryCryptoRng, TryRngCore};
4141
///
4242
/// # Error handling
4343
///
44-
/// Although unlikely, reseeding the wrapped PRNG can fail. `ReseedingRng` will
45-
/// never panic but try to handle the error intelligently through some
46-
/// combination of retrying and delaying reseeding until later.
47-
/// If handling the source error fails `ReseedingRng` will continue generating
48-
/// data from the wrapped PRNG without reseeding.
44+
/// Errors during reseeding are extremely unlikely, assuming the same random
45+
/// source successfully initialized the inner PRNG. A reseeding failure will be
46+
/// reported via panic (new behaviour since v0.9.3).
4947
///
50-
/// Manually calling [`reseed()`] will not have this retry or delay logic, but
51-
/// reports the error.
48+
/// Manually calling [`reseed()`] will report errors.
5249
///
5350
/// # Example
5451
///

0 commit comments

Comments
 (0)