Struct Rng 

#[non_exhaustive]
pub struct Rng;

(Pseudo-)Random Number Generator.

To generate pseudo-random numbers, you can create Rng at any time. To generate true random numbers, see Trng.

Implementations

impl Rng

pub fn new() -> Self

Creates a new random number generator instance.

pub fn random(&self) -> u32

Reads currently available u32 integer from RNG.

Example

use esp_hal::rng::Rng;

let rng = Rng::new();
let random_number = rng.random();

pub fn read(&self, buffer: &mut [u8])

Reads enough bytes from hardware random number generator to fill buffer.

Example

use esp_hal::rng::Rng;

let rng = Rng::new();
let mut rng_values = [0; 10];
rng.read(&mut rng_values);

pub unsafe fn read_into_raw(&self, ptr: *mut u8, len: usize)

Available on crate feature unstable only.

Reads enough bytes from hardware random number generator to fill buffer.

If any error is encountered then this function immediately returns. The contents of buf are unspecified in this case.

Safety

ptr must not be null and valid for writes for len bytes.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations

impl Clone for Rng

fn clone(&self) -> Rng

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rng

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Rng

fn default() -> Rng

Returns the “default value” for a type.

impl RngCore for Rng

Available on crate feature unstable only.

Compatibility with rand_core 0.6. Documentation can be found at https://docs.rs/rand_core/0.6.4/rand_core/trait.RngCore.html.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn fill_bytes(&mut self, dest: &mut [u8])

Fill dest with random data.

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Fill dest entirely with random data.

impl RngCore for Rng

Available on crate feature unstable only.

Compatibility with rand_core 0.9. Documentation can be found at https://docs.rs/rand_core/0.9.5/rand_core/trait.RngCore.html.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn fill_bytes(&mut self, dest: &mut [u8])

Fill dest with random data.

impl TryRng for Rng

Available on crate feature unstable only.

Compatibility with rand_core 0.10

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

type Error = Infallible

The type returned in the event of a RNG error.

fn try_next_u32(&mut self) -> Result<u32, Self::Error>

Return the next random u32.

fn try_next_u64(&mut self) -> Result<u64, Self::Error>

Return the next random u64.

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Self::Error>

Fill dst entirely with random data.

impl Copy for Rng