Embassy

Flavors

Skip to main content

Rng

embassy_stm32::rng

Struct Rng

pub struct Rng<'d, M: Mode> { /* private fields */ }

Expand description

RNG driver.

Implementations§

impl<'d> Rng<'d, Async>

pub fn new<T: Instance>( inner: Peri<'d, T>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, ) -> Self

Create a new RNG driver.

impl<'d> Rng<'d, Blocking>

pub fn new_blocking<T: Instance>(inner: Peri<'d, T>) -> Self

Create a new blocking RNG driver.

impl<'d, M: Mode> Rng<'d, M>

pub fn reset(&mut self)

Reset the RNG.

pub fn recover_seed_error(&mut self)

Try to recover from a seed error.

pub fn blocking_next_u32(&mut self) -> u32

Get a random u32.

This call is infallible: a seed or clock error is recovered by resetting the RNG. If the error persists after MAX_RESET_RETRIES resets (almost always a misconfigured RNG clock) it panics, since an infallible API has no other way to surface the fault. Use fill_bytes for a fallible path that returns Error instead.

pub fn blocking_next_u64(&mut self) -> u64

Get a random u64

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

Fill a slice with random bytes

impl<'d> Rng<'d, Async>

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

Fill the given slice with random values.

Trait Implementations§

impl<'d, M: Mode> CryptoRng for Rng<'d, M>

impl<'d, M: Mode> CryptoRng for Rng<'d, M>

impl<'d, M: Mode> Drop for Rng<'d, M>

fn drop(&mut self)

Executes the destructor for this type. Read more

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

impl<'d, M: Mode> RngCore for Rng<'d, M>

fn next_u32(&mut self) -> u32

Return the next random u32. Read more

fn next_u64(&mut self) -> u64

Return the next random u64. Read more

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

Fill dest with random data. Read more

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

Fill dest entirely with random data. Read more

impl<'d, M: Mode> RngCore for Rng<'d, M>

fn next_u32(&mut self) -> u32

Return the next random u32. Read more

fn next_u64(&mut self) -> u64

Return the next random u64. Read more

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

Fill dest with random data. Read more

impl<'d, M: Mode> TryCryptoRng for Rng<'d, M>

impl<'d, M: Mode> TryRng for Rng<'d, M>

type Error = !

The type returned in the event of a RNG error. Read more

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.

Auto Trait Implementations§

impl<'d, M> !UnwindSafe for Rng<'d, M>

impl<'d, M> Freeze for Rng<'d, M>
where PhantomData<(&'d mut (), M)>: Freeze,

impl<'d, M> RefUnwindSafe for Rng<'d, M>
where PhantomData<(&'d mut (), M)>: RefUnwindSafe,

impl<'d, M> Send for Rng<'d, M>
where PhantomData<(&'d mut (), M)>: Send,

impl<'d, M> Sync for Rng<'d, M>
where PhantomData<(&'d mut (), M)>: Sync,

impl<'d, M> Unpin for Rng<'d, M>
where PhantomData<(&'d mut (), M)>: Unpin,

impl<'d, M> UnsafeUnpin for Rng<'d, M>
where PhantomData<(&'d mut (), M)>: UnsafeUnpin,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<R> CryptoRng for R
where R: TryCryptoRng<Error = !> + ?Sized,

impl<T> CryptoRngCore for T
where T: CryptoRng + RngCore,

fn as_rngcore(&mut self) -> &mut dyn RngCore

Upcast to an RngCore trait object.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<R> Rng for R
where R: TryRng<Error = !> + ?Sized,

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, dst: &mut [u8])

Fill dest with random data. Read more

impl<R> RngCore for R
where R: Rng,

impl<_INNER> SuspendablePeripheral for _INNER
where _INNER: SealedSuspendablePeripheral,

impl<R> TryCryptoRng for R
where R: CryptoRng + ?Sized,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<R> TryRngCore for R
where R: RngCore + ?Sized,

type Error = !

The type returned in the event of a RNG error.

fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>

Return the next random u32.

fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>

Return the next random u64.

fn try_fill_bytes( &mut self, dst: &mut [u8], ) -> Result<(), <R as TryRngCore>::Error>

Fill dest entirely with random data.

fn unwrap_err(self) -> UnwrapErr<Self>
where Self: Sized,

Wrap RNG with the UnwrapErr wrapper.

fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>

Wrap RNG with the UnwrapMut wrapper.

impl<R> TryRngCore for R
where R: TryRng,

type Error = <R as TryRng>::Error

👎Deprecated since 0.10.0:

use TryRng instead

Error type.