rand_core

What's Changed

• rand v0.9.5: backport #1790 by @dhardy in #1803

Full Changelog: 0.9.4...0.9.5

Fixes

• Fix doc build (#1766)

Full Changelog: 0.9.3...0.9.4

This release back-ports a fix from v0.10. See also [#1763].

Changes

• Deprecate feature log (#1764)
• Replace usages of doc_auto_cfg (#1764)

Full Changelog: 0.9.2...0.9.3

Deprecated

• Deprecate rand::rngs::mock module and StepRng generator ([#1634])

Additions

• Enable WeightedIndex<usize> (de)serialization ([#1646])

Security and unsafe

• Revise "not a crypto library" policy again (#1565)
• Remove zerocopy dependency from rand (#1579)

Fixes

• Fix feature simd_support for recent nightly rust (#1586)

Changes

• Allow fn rand::seq::index::sample_weighted and fn IndexedRandom::choose_multiple_weighted to return fewer than amount results (#1623), reverting an undocumented change ([#1382]) to the previous release.

Additions

• Add rand::distr::Alphabetic distribution. (#1587)
• Re-export rand_core (#1604)

Security and unsafe

• Policy: "rand is not a crypto library" (#1514)
• Remove fork-protection from ReseedingRng and ThreadRng. Instead, it is recommended to call ThreadRng::reseed on fork. (#1379)
• Use zerocopy to replace some unsafe code (#1349, #1393, #1446, #1502)

Dependencies

• Bump the MSRV to 1.63.0 (#1207, #1246, #1269, #1341, #1416, #1536); note that 1.60.0 may work for dependents when using --ignore-rust-version
• Update to rand_core v0.9.0 (#1558)

Features

• Support std feature without getrandom or rand_chacha (#1354)
• Enable feature small_rng by default (#1455)
• Remove implicit feature rand_chacha; use std_rng instead. (#1473)
• Rename feature serde1 to serde (#1477)
• Rename feature getrandom to os_rng (#1537)
• Add feature thread_rng (#1547)

API changes: rand_core traits

• Add fn RngCore::read_adapter implementing std::io::Read (#1267)
• Add trait CryptoBlockRng: BlockRngCore; make trait CryptoRng: RngCore (#1273)
• Add traits TryRngCore, TryCryptoRng (#1424, #1499)
• Rename fn SeedableRng::from_rng -> try_from_rng and add infallible variant fn from_rng (#1424)
• Rename fn SeedableRng::from_entropy -> from_os_rng and add fallible variant fn try_from_os_rng (#1424)
• Add bounds Clone and AsRef to associated type SeedableRng::Seed (#1491)

API changes: Rng trait and top-level fns

• Rename fn rand::thread_rng() to rand::rng() and remove from the prelude (#1506)
• Remove fn rand::random() from the prelude (#1506)
• Add top-level fns random_iter, random_range, random_bool, random_ratio, fill (#1488)
• Re-introduce fn Rng::gen_iter as random_iter (#1305, #1500)
• Rename fn Rng::gen to random to avoid conflict with the new gen keyword in Rust 2024 (#1438)
• Rename fns Rng::gen_range to random_range, gen_bool to random_bool, gen_ratio to random_ratio (#1505)
• Annotate panicking methods with #[track_caller] (#1442, #1447)

API changes: RNGs

• Fix <SmallRng as SeedableRng>::Seed size to 256 bits (#1455)
• Remove first parameter (rng) of ReseedingRng::new (#1533)

API changes: Sequences

• Split trait SliceRandom into IndexedRandom, IndexedMutRandom, SliceRandom (#1382)
• Add IndexedRandom::choose_multiple_array, index::sample_array (#1453, #1469)

API changes: Distributions: renames

• Rename module rand::distributions to rand::distr (#1470)
• Rename distribution Standard to StandardUniform (#1526)
• Move distr::Slice -> distr::slice::Choose, distr::EmptySlice -> distr::slice::Empty (#1548)
• Rename trait distr::DistString -> distr::SampleString (#1548)
• Rename distr::DistIter -> distr::Iter, distr::DistMap -> distr::Map (#1548)

API changes: Distributions

• Relax Sized bound on Distribution<T> for &D (#1278)
• Remove impl of Distribution<Option<T>> for StandardUniform (#1526)
• Let distribution StandardUniform support all NonZero* types (#1332)
• Fns {Uniform, UniformSampler}::{new, new_inclusive} return a Result (instead of potentially panicking) (#1229)
• Distribution Uniform implements TryFrom instead of From for ranges (#1229)
• Add UniformUsize (#1487)
• Remove support for generating isize and usize values with StandardUniform, Uniform (except via UniformUsize) and Fill and usage as a WeightedAliasIndex weight (#1487)
• Add impl DistString for distributions Slice<char> and Uniform<char> (#1315)
• Add fn Slice::num_choices (#1402)
• Add fn p() for distribution Bernoulli to access probability (#1481)

API changes: Weighted distributions

• Add pub module rand::distr::weighted, moving WeightedIndex there (#1548)
• Add trait weighted::Weight, allowing WeightedIndex to trap overflow (#1353)
• Add fns weight, weights, total_weight to distribution WeightedIndex (#1420)
• Rename enum WeightedError to weighted::Error, revising variants (#1382) and mark as #[non_exhaustive] (#1480)

API changes: SIMD

• Switch to std::simd, expand SIMD & docs (#1239)

Reproducibility-breaking changes

• Make ReseedingRng::reseed discard remaining data from the last block generated (#1379)
• Change fn SmallRng::seed_from_u64 implementation (#1203)
• Allow UniformFloat::new samples and UniformFloat::sample_single to yield high (#1462)
• Fix portability of distribution Slice (#1469)
• Make Uniform for usize portable via UniformUsize (#1487)
• Fix IndexdRandom::choose_multiple_weighted for very small seeds and optimize for large input length / low memory (#1530)

Reproducibility-breaking optimisations

• Optimize fn sample_floyd, affecting output of rand::seq::index::sample and rand::seq::SliceRandom::choose_multiple (#1277)
• New, faster algorithms for IteratorRandom::choose and choose_stable (#1268)
• New, faster algorithms for SliceRandom::shuffle and partial_shuffle (#1272)
• Optimize distribution Uniform: use Canon's method (single sampling) / Lemire's method (distribution sampling) for faster sampling (breaks value stability; #1287)
• Optimize fn sample_single_inclusive for floats (+~20% perf) (#1289)

Other optimisations

• Improve SmallRng initialization performance (#1482)
• Optimise SIMD widening multiply (#1247)

Other

• Add Cargo.lock.msrv file (#1275)
• Reformat with rustfmt and enforce (#1448)
• Apply Clippy suggestions and enforce (#1448, #1474)
• Move all benchmarks to new benches crate (#1329, #1439) and migrate to Criterion (#1490)

Documentation

• Improve ThreadRng related docs (#1257)
• Docs: enable experimental --generate-link-to-definition feature (#1327)
• Better doc of crate features, use doc_auto_cfg (#1411, #1450)

Fixes

• Move wasm-bindgen shims to correct crate ([#686])
• Make wasm32-unknown-unknown compile but fail at run-time if missing bindings ([#686])

Fixes

• Make the std feature require the optional rand_os dependency ([#675])
• Re-export the optional WASM dependencies of rand_os from rand to avoid breakage ([#674])

Additions

• Add Default for ThreadRng ([#657])
• Move rngs::OsRng to rand_os sub-crate; clean up code; use as dependency ([#643])
• Add rand_xoshiro sub-crate, plus benchmarks ([#642], [#668])

Fixes

• Fix bias in UniformInt::sample_single ([#662])
• Use autocfg instead of rustc_version for rustc version detection ([#664])
• Disable i128 and u128 if the target_os is emscripten ([#671]: work-around Emscripten limitation)
• CI fixes ([#660], [#671])

Optimisations

• Optimise memory usage of UnitCircle and UnitSphereSurface distributions (no PR)

• Support sampling Duration also for no_std (only since Rust 1.25) ([#649])
• Disable default features of libc ([#647])

Project organisation

• Rand has moved from rust-lang-nursery to rust-random! (#578)
• Created The Rust Random Book (source)
• Update copyright and licence notices (#591, #611)
• Migrate policy documentation from the wiki (#544)

Platforms

• Add fork protection on Unix (#466)
• Added support for wasm-bindgen (#541, #559, #562, #600)
• Enable OsRng for powerpc64, sparc and sparc64 (#609)
• Use syscall from libc on Linux instead of redefining it (#629)

RNGs

• Switch SmallRng to use PCG (#623)
• Implement Pcg32 and Pcg64Mcg generators (#632)
• Move ISAAC RNGs to a dedicated crate (#551)
• Move Xorshift RNG to its own crate (#557)
• Move ChaCha and HC128 RNGs to dedicated crates (#607, #636)
• Remove usage of Rc from ThreadRng (#615)

Sampling and distributions

• Implement Rng.gen_ratio() and Bernoulli::new_ratio() (#491)
• Make Uniform strictly respect f32 / f64 high/low bounds (#477)
• Allow gen_range and Uniform to work on non-Copy types (#506)
• Uniform supports inclusive ranges: Uniform::from(a..=b). This is automatically enabled for Rust >= 1.27. (#566)
• Implement TrustedLen and FusedIterator for DistIter (#620)

New distributions

• Add the Dirichlet distribution (#485)
• Added sampling from the unit sphere and circle (#567)
• Implement the triangular distribution (#575)
• Implement the Weibull distribution (#576)
• Implement the Beta distribution (#574)

Optimisations

• Optimise Bernoulli::new (#500)
• Optimise char sampling (#519)
• Optimise sampling of std::time::Duration (#583)

Sequences

• Redesign the seq module (#483, #515)
• Add WeightedIndex and choose_weighted (#518, #547)
• Optimised and changed return type of the sample_indices function (#479)
• Use Iterator::size_hint() to speed up IteratorRandom::choose (#593)

SIMD

• Support for generating SIMD types (#523, #542, #561, #630)

Other

• Revise CI scripts (#632, #635)
• Remove functionality already deprecated in 0.5 (#499)
• Support for i128 and u128 is automatically enabled for Rust >= 1.26. This renders the i128_support feature obsolete. It still exists for backwards compatibility but does not have any effect. This breaks programs using Rand with i128_support on nightlies older than Rust 1.26. (#571)

New distributions

• Added Cauchy distribution. ([#474], [#486])
• Added Pareto distribution. ([#495])

Platform support and OsRng

• Remove blanket Unix implementation. ([#484])
• Remove Wasm unimplemented stub. ([#484])
• Dragonfly BSD: read from /dev/random. ([#484])
• Bitrig: use getentropy like OpenBSD. ([#484])
• Solaris: (untested) use getrandom if available, otherwise /dev/random. ([#484])
• Emscripten, stdweb: split the read up in chunks. ([#484])
• Emscripten, Haiku: don't do an extra blocking read from /dev/random. ([#484])
• Linux, NetBSD, Solaris: read in blocking mode on first use in fill_bytes. ([#484])
• Fuchsia, CloudABI: fix compilation (broken in Rand 0.5). ([#484])

Crate features and organisation

• Minimum Rust version update: 1.22.0. (#239)
• Create a separate rand_core crate. (#288)
• Deprecate rand_derive. (#256)
• Add prelude (and module reorganisation). (#435)
• Add log feature. Logging is now available in JitterRng, OsRng, EntropyRng and ReseedingRng. (#246)
• Add serde1 feature for some PRNGs. (#189)
• stdweb feature for OsRng support on WASM via stdweb. (#272, #336)

Rng trait

• Split Rng into RngCore and Rng extension trait. next_u32, next_u64 and fill_bytes are now part of RngCore. (#265)
• Add Rng::sample. (#256)
• Deprecate Rng::gen_weighted_bool. (#308)
• Add Rng::gen_bool. (#308)
• Remove Rng::next_f32 and Rng::next_f64. (#273)
• Add optimized Rng::fill and Rng::try_fill methods. (#247)
• Deprecate Rng::gen_iter. (#286)
• Deprecate Rng::gen_ascii_chars. (#279)

rand_core crate

• rand now depends on new rand_core crate (#288)
• RngCore and SeedableRng are now part of rand_core. (#288)
• Add modules to help implementing RNGs impl and le. (#209, #228)
• Add Error and ErrorKind. (#225)
• Add CryptoRng marker trait. (#273)
• Add BlockRngCore trait. (#281)
• Add BlockRng and BlockRng64 wrappers to help implementations. (#281, #325)
• Revise the SeedableRng trait. (#233)
• Remove default implementations for RngCore::next_u64 and RngCore::fill_bytes. (#288)
• Add RngCore::try_fill_bytes. (#225)

Other traits and types

• Add FromEntropy trait. (#233, #375)
• Add SmallRng wrapper. (#296)
• Rewrite ReseedingRng to only work with BlockRngCore (substantial performance improvement). (#281)
• Deprecate weak_rng. Use SmallRng instead. (#296)
• Deprecate AsciiGenerator. (#279)

Random number generators

• Switch StdRng and thread_rng to HC-128. (#277)
• StdRng must now be created with from_entropy instead of new
• Change thread_rng reseeding threshold to 32 MiB. (#277)
• PRNGs no longer implement Copy. (#209)
• Debug implementations no longer show internals. (#209)
• Implement Clone for ReseedingRng, JitterRng, OsRng`. (#383, #384)
• Implement serialization for XorShiftRng, IsaacRng and Isaac64Rng under the serde1 feature. (#189)
• Implement BlockRngCore for ChaChaCore and Hc128Core. (#281)
• All PRNGs are now portable across big- and little-endian architectures. (#209)
• Isaac64Rng::next_u32 no longer throws away half the results. (#209)
• Add IsaacRng::new_from_u64 and Isaac64Rng::new_from_u64. (#209)
• Add the HC-128 CSPRNG Hc128Rng. (#210)
• Change ChaCha20 to have 64-bit counter and 64-bit stream. (#349)
• Changes to JitterRng to get its size down from 2112 to 24 bytes. (#251)
• Various performance improvements to all PRNGs.

Platform support and OsRng

• Add support for CloudABI. (#224)
• Remove support for NaCl. (#225)
• WASM support for OsRng via stdweb, behind the stdweb feature. (#272, #336)
• Use getrandom on more platforms for Linux, and on Android. (#338)
• Use the SecRandomCopyBytes interface on macOS. (#322)
• On systems that do not have a syscall interface, only keep a single file descriptor open for OsRng. (#239)
• On Unix, first try a single read from /dev/random, then /dev/urandom. (#338)
• Better error handling and reporting in OsRng (using new error type). (#225)
• OsRng now uses non-blocking when available. (#225)
• Add EntropyRng, which provides OsRng, but has JitterRng as a fallback. (#235)

Distributions

• New Distribution trait. (#256)
• Add Distribution::sample_iter and Rng::::sample_iter. (#361)
• Deprecate Rand, Sample and IndependentSample traits. (#256)
• Add a Standard distribution (replaces most Rand implementations). (#256)
• Add Binomial and Poisson distributions. (#96)
• Add Bernoulli dsitribution. (#411)
• Add Alphanumeric distribution. (#279)
• Remove Closed01 distribution, add OpenClosed01. (#274, #420)
• Rework Range type, making it possible to implement it for user types. (#274)
• Rename Range to Uniform. (#395)
• Add Uniform::new_inclusive for inclusive ranges. (#274)
• Use widening multiply method for much faster integer range reduction. (#274)
• Standard distribution for char uses Uniform internally. (#274)
• Standard distribution for bool uses sign test. (#274)
• Implement Standard distribution for Wrapping<T>. (#436)
• Implement Uniform distribution for Duration. (#427)

Fixed

• Use correct syscall number for PowerPC ([#589])

Changed

• Use winapi on Windows
• Update for Fuchsia OS
• Remove dev-dependency on log

Added

• no_std support

Changed

• Disable the std feature by default (rand#702)

Fixed

• Fix compile on Windows

Changed

• Update to use log version 0.3.x

Fixed

• Compatible with Rust master
• Fixed iOS compilation

Fixed

• Compatible with Rust master (move from old_io to std::io)

Added

• Migrate to a cargo-compatible directory structure.

Fixed

• Do not use entropy during gen_weighted_bool(1)

(Split out of the Rand crate, changes here are relative to rand 0.4.2.)

Added

• RngCore and SeedableRng are now part of rand_core. (rand#288)
• Add modules to help implementing RNGs impl and le. (rand#209, rand#228)
• Add Error and ErrorKind. (rand#225)
• Add CryptoRng marker trait. (rand#273)
• Add BlockRngCore trait. (rand#281)
• Add BlockRng and BlockRng64 wrappers to help implementations. (rand#281, rand#325)
• Add RngCore::try_fill_bytes. (rand#225)

Changed

• Revise the SeedableRng trait. (rand#233)
• Remove default implementations for RngCore::next_u64 and RngCore::fill_bytes. (rand#288)