mirror of
https://git.proxmox.com/git/rustc
synced 2025-08-19 01:16:10 +00:00
57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
# getrandom
|
|
|
|
[](https://travis-ci.org/rust-random/getrandom)
|
|
[](https://ci.appveyor.com/project/rust-random/getrandom)
|
|
[](https://crates.io/crates/getrandom)
|
|
[](https://docs.rs/getrandom)
|
|
[](https://deps.rs/repo/github/rust-random/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`].
|
|
|
|
[`rand`]: https://crates.io/crates/rand
|
|
|
|
## Usage
|
|
|
|
Add this to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
getrandom = "0.2"
|
|
```
|
|
|
|
Then invoke the `getrandom` function:
|
|
|
|
```rust
|
|
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](https://docs.rs/getrandom/latest) and
|
|
[`getrandom::Error` documentation](https://docs.rs/getrandom/latest/getrandom/struct.Error.html).
|
|
|
|
## Minimum Supported Rust Version
|
|
|
|
This crate requires Rust 1.34.0 or later.
|
|
|
|
# License
|
|
|
|
The `getrandom` library is distributed under either of
|
|
|
|
* [Apache License, Version 2.0](LICENSE-APACHE)
|
|
* [MIT license](LICENSE-MIT)
|
|
|
|
at your option.
|