aosp12/external/rust/crates/getrandom
hcl 7be3fd486c init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
..
benches init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
src init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
tests init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
.cargo_vcs_info.json init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
Android.bp init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
CHANGELOG.md init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
Cargo.toml init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
Cargo.toml.orig init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
LICENSE init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
LICENSE-APACHE init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
LICENSE-MIT init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
METADATA init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
MODULE_LICENSE_APACHE2 init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
OWNERS init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
README.md init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
TEST_MAPPING init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
build.rs init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00
cargo2android.json init from android-12.1.0_r8 2023-01-09 17:11:35 +08:00

README.md

getrandom

Build Status Crate Documentation Dependency Status Downloads License

A Rust library for retrieving random data from (operating) system source. It is assumed that system always provides high-quality cryptographically secure random data, ideally backed by hardware entropy sources. This crate derives its name from Linux's getrandom function, but is cross platform, roughly supporting the same set of platforms as Rust's std lib.

This is a low-level API. Most users should prefer using high-level random-number library like rand.

Usage

Add this to your Cargo.toml:

[dependencies]
getrandom = "0.2"

Then invoke the getrandom function:

fn get_random_buf() -> Result<[u8; 32], getrandom::Error> {
    let mut buf = [0u8; 32];
    getrandom::getrandom(&mut buf)?;
    Ok(buf)
}

For more information about supported targets, entropy sources, no_std targets, crate features, WASM support and Custom RNGs see the getrandom documentation and getrandom::Error documentation.

Minimum Supported Rust Version

This crate requires Rust 1.34.0 or later.

License

The getrandom library is distributed under either of

at your option.