Many performance optimisations thanks to contributions from the wide
user-base
Rand is not:
Small (LoC). Most low-level crates are small, but the higher-level rand
and rand_distr each contain a lot of functionality.
Simple (implementation). We have a strong focus on correctness, speed and flexibility, but
not simplicity. If you prefer a small-and-simple library, there are
alternatives including fastrand
and oorandom.
Primarily a cryptographic library. rand does provide some generators which
aim to support unpredictable value generation under certain constraints;
see SECURITY.md for details.
Users are expected to determine for themselves
whether rand‘s functionality meets their own security requirements.
Rand is mature (suitable for general usage, with infrequent breaking releases
which minimise breakage) but not yet at 1.0. Current MAJOR.MINOR versions are:
nightly includes some additions requiring nightly Rust
simd_support (experimental) enables sampling of SIMD values
(uniformly random SIMD integers and floats), requiring nightly Rust
unbiased use unbiased sampling for algorithms supporting this option: Uniform distribution.
(By default, bias affecting no more than one in 2^48 samples is accepted.)
Note: enabling this option is expected to affect reproducibility of results.
Note 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 os_rng is enabled), large parts of seq are
unavailable (unless alloc is enabled), and ThreadRng is unavailable.
Portability and platform support
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.
WebAssembly support
The WASI and Emscripten
targets are directly supported. The wasm32-unknown-unknown target is not
automatically supported. To enable support for this target, refer to the
getrandom documentation for WebAssembly.
Alternatively, the os_rng feature may be disabled.
License
Rand is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).
Rand
Rand is a set of crates supporting (pseudo-)random generators:
rand_core::RngCore
rand::rngs
, and more RNGs:rand_chacha
,rand_xoshiro
,rand_pcg
, rngs reporand::rng
is an asymptotically-fast, automatically-seeded and reasonably strong generator available on allstd
targetsWith broad support for random value generation and random processes:
StandardUniform
random value sampling,Uniform
-ranged value sampling and morerand_distr
and via thestatrs
rand::seq
traitsAll with:
#[no_std]
compatibility (partial)Rand is not:
rand
andrand_distr
each contain a lot of functionality.rand
does provide some generators which aim to support unpredictable value generation under certain constraints; see SECURITY.md for details. Users are expected to determine for themselves whetherrand
‘s functionality meets their own security requirements.Documentation:
Versions
Rand is mature (suitable for general usage, with infrequent breaking releases which minimise breakage) but not yet at 1.0. Current
MAJOR.MINOR
versions are:See the CHANGELOG or Upgrade Guide for more details.
Crate Features
Rand is built with these features enabled by default:
std
enables functionality dependent on thestd
liballoc
(implied bystd
) enables functionality requiring an allocatoros_rng
(implied bystd
) enablesrngs::OsRng
, using the getrandom cratestd_rng
enables inclusion ofStdRng
,ThreadRng
small_rng
enables inclusion of theSmallRng
PRNGOptionally, the following dependencies can be enabled:
log
enables logging via logAdditionally, these features configure Rand:
nightly
includes some additions requiring nightly Rustsimd_support
(experimental) enables sampling of SIMD values (uniformly random SIMD integers and floats), requiring nightly Rustunbiased
use unbiased sampling for algorithms supporting this option: Uniform distribution.(By default, bias affecting no more than one in 2^48 samples is accepted.)
Note: enabling this option is expected to affect reproducibility of results.
Note 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 viadefault-features = false
). In this case,OsRng
andfrom_os_rng
are unavailable (unlessos_rng
is enabled), large parts ofseq
are unavailable (unlessalloc
is enabled), andThreadRng
is unavailable.Portability and platform support
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.
WebAssembly support
The WASI and Emscripten targets are directly supported. The
wasm32-unknown-unknown
target is not automatically supported. To enable support for this target, refer to thegetrandom
documentation for WebAssembly. Alternatively, theos_rng
feature may be disabled.License
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.