A Rust library for random number generators and other randomness functionality.
See also:
Documentation: master branch, by release
Add this to your Cargo.toml
:
[dependencies] rand = "0.5.0-pre.0"
and this to your crate root:
extern crate rand; // example usage: use rand::{Rng, thread_rng}; let x: f64 = thread_rng().gen();
Version 0.5 is in development and contains many breaking changes; expected release date is approx. end of March 2018 if all goes well.
Version 0.4 was released in December 2017. It contains almost no breaking changes since the 0.3 series.
For more details, see the changelog.
The 0.5 release of Rand will require Rustc version 1.22 or greater. Rand 0.4 and 0.3 (since approx. June 2017) require Rustc version 1.15 or greater. Subsets of the Rand code may work with older Rust versions, but this is not supported.
Travis CI always has a build with a pinned version of Rustc matching the oldest supported Rust release. The current policy is that this can be updated in any Rand release if required, but the change must be noted in the changelog.
The rand_core
crate provides:
The rand
crate provides:
rand_core
(re-exported)EntropyRng
, OsRng
, JitterRng
StdRng
, SmallRng
, prng
modulethread_rng
distributions
producing many different types of random values:Uniform
-ly distributed integers and floats of many typesRange
sgen_bool
aka Bernoulli distributionseq
-uence related functionality:By default, Rand is built with all stable features available. The following optional features are available:
alloc
can be used instead of std
to provide Vec
and Box
i128_support
enables support for generating u128
and i128
valueslog
enables some logging via the log
cratenightly
enables all unstable features (i128_support
)serde-1
enables serialisation for some types, via Serde version 1stdweb
enables support for OsRng
on WASM via stdweb.std
enabled by default; by setting “default-features = false” no_std
mode is activated; this removes features depending on std
functionality:OsRng
is entirely unavailableJitterRng
code is still present, but a nanosecond timer must be provided via JitterRng::new_with_timer
thread_rng
, weak_rng
and random
are all disabledexp
and log
functions are not provided in core
Vec
or Box
Unfortunately, cargo test
does not test everything. The following tests are recommended:
# Basic tests for Rand and sub-crates cargo test --all # Test no_std support cargo test --tests --no-default-features # Test no_std+alloc support cargo test --tests --no-default-features --features alloc # Test log and serde support cargo test --features serde-1,log # Test 128-bit support (requires nightly) cargo test --all --features nightly # Benchmarks (requires nightly) cargo bench # or just to test the benchmark code: cargo test --benches
Rand is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.