commit	439c1157b20cc07369c44ff046dcfce6c1e5adb0	[log] [tgz]
author	Android Build Coastguard Worker <android-build-coastguard-worker@google.com>	Tue Jan 10 00:14:42 2023 +0000
committer	Android Build Coastguard Worker <android-build-coastguard-worker@google.com>	Tue Jan 10 00:14:42 2023 +0000
tree	aea8128a071e1ea6d7b6ce26379865efb0862da9
parent	67ee42f84fb56bd3a9278b1062bc12f6639988ae [diff]
parent	6faa01ec63389679829118250276c26652708fb9 [diff]

tree: aea8128a071e1ea6d7b6ce26379865efb0862da9

README.md

getrandom

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.