A Rust library for random number generation.
OTHER License
Rand is a Rust library supporting random generators:
rand_core::RngCore
rand::rngs
, and more RNGs: rand_chacha
, rand_xoshiro
, rand_pcg
, rngs repo
rand::thread_rng
is an asymtotically-fast, reasonably secure generator available on all std
targetsgetrandom
crate
Supporting random value generation and random processes:
Standard
random value generationUniform
number generation for many typesdistributions
modulerand_distr
and viastatrs
rand::seq
traitsAll with:
#[no_std]
compatibility (partial)It's also worth pointing out what Rand is not:
rand
andrand_distr
each contain a lot of functionality.Documentation:
Add this to your Cargo.toml
:
[dependencies]
rand = "0.8.5"
To get started using Rand, see The Book.
Rand is mature (suitable for general usage, with infrequent breaking releases which minimise breakage) but not yet at 1.0. Current versions are:
See the CHANGELOG or Upgrade Guide for more details.
Rand is built with these features enabled by default:
std
enables functionality dependent on the std
liballoc
(implied by std
) enables functionality requiring an allocatorgetrandom
(implied by std
) is an optional dependency providing the coderngs::OsRng
std_rng
enables inclusion of StdRng
, thread_rng
Optionally, the following dependencies can be enabled:
log
enables logging via log
Additionally, these features configure Rand:
small_rng
enables inclusion of the SmallRng
PRNGnightly
includes some additions requiring nightly Rustsimd_support
(experimental) enables sampling of SIMD valuesNote that nightly features are not stable and therefore not all library and
compiler versions will be compatible. This is especially true of Rand's
experimental simd_support
feature.
Rand supports limited functionality in no_std
mode (enabled via
default-features = false
). In this case, OsRng
and from_os_rng
are
unavailable (unless getrandom
is enabled), large parts of seq
are
unavailable (unless alloc
is enabled), and thread_rng
is unavailable.
Many (but not all) algorithms are intended to have reproducible output. Read more in the book: Portability.
The Rand library supports a variety of CPU architectures. Platform integration is outsourced to getrandom.
Seeding entropy from OS on WASM target wasm32-unknown-unknown
is not
automatically supported by rand
or getrandom
. If you are fine with
seeding the generator manually, you can disable the getrandom
feature
and use the methods on the SeedableRng
trait. To enable seeding from OS,
either use a different target such as wasm32-wasi
or add a direct
dependency on getrandom
with the js
feature (if the target supports
JavaScript). See
getrandom#WebAssembly support.
Rand is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT, and COPYRIGHT for details.