Struct rdrand::RdRand

source ·
pub struct RdRand(_);
Expand description

A cryptographically secure statistically uniform, non-periodic and non-deterministic random bit generator.

Note that this generator may be implemented using a deterministic algorithm that is reseeded routinely from a non-deterministic entropy source to achieve the desirable properties.

This generator is a viable replacement to any generator, however, since nobody has audited Intel or AMD hardware yet, the usual disclaimers as to their suitability apply.

It is potentially faster than OsRng, but is only supported on more recent Intel (Ivy Bridge and later) and AMD (Ryzen and later) processors.

Implementations§

source§

impl RdRand

source

pub fn new() -> Result<Self, Error>

Create a new instance of the random number generator.

This constructor checks whether the CPU the program is running on supports the instruction necessary for this generator to operate. If the instruction is not supported, an error is returned.

source

pub fn try_next_u16(&self) -> Option<u16>

Generate a single random u16 value.

The underlying instruction may fail for variety reasons (such as actual hardware failure or exhausted entropy), however the exact reason for the failure is not usually exposed.

This method will retry calling the instruction a few times, however if all the attempts fail, it will return None.

In case None is returned, the caller should assume that an non-recoverable hardware failure has occured and use another random number genrator instead.

source

pub fn try_next_u32(&self) -> Option<u32>

Generate a single random u32 value.

The underlying instruction may fail for variety reasons (such as actual hardware failure or exhausted entropy), however the exact reason for the failure is not usually exposed.

This method will retry calling the instruction a few times, however if all the attempts fail, it will return None.

In case None is returned, the caller should assume that an non-recoverable hardware failure has occured and use another random number genrator instead.

source

pub fn try_next_u64(&self) -> Option<u64>

Generate a single random u64 value.

The underlying instruction may fail for variety reasons (such as actual hardware failure or exhausted entropy), however the exact reason for the failure is not usually exposed.

This method will retry calling the instruction a few times, however if all the attempts fail, it will return None.

In case None is returned, the caller should assume that an non-recoverable hardware failure has occured and use another random number genrator instead.

Note, that on 32-bit targets, there’s no underlying instruction to generate a 64-bit number, so it is emulated with the 32-bit version of the instruction.

Trait Implementations§

source§

impl Clone for RdRand

source§

fn clone(&self) -> RdRand

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl RngCore for RdRand

source§

fn next_u32(&mut self) -> u32

Generate a single random u32 value.

The underlying instruction may fail for variety reasons (such as actual hardware failure or exhausted entropy), however the exact reason for the failure is not usually exposed.

Panic

This method will retry calling the instruction a few times, however if all the attempts fail, it will panic.

In case panic occurs, the caller should assume that an non-recoverable hardware failure has occured and use another random number genrator instead.

source§

fn next_u64(&mut self) -> u64

Generate a single random u64 value.

The underlying instruction may fail for variety reasons (such as actual hardware failure or exhausted entropy), however the exact reason for the failure is not usually exposed.

Note, that on 32-bit targets, there’s no underlying instruction to generate a 64-bit number, so it is emulated with the 32-bit version of the instruction.

Panic

This method will retry calling the instruction a few times, however if all the attempts fail, it will panic.

In case panic occurs, the caller should assume that an non-recoverable hardware failure has occured and use another random number genrator instead.

source§

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

Fill a buffer dest with random data.

See try_fill_bytes for a more extensive documentation.

Panic

This method will panic any time try_fill_bytes would return an error.

source§

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

Fill a buffer dest with random data.

This method will use the most appropriate variant of the instruction available on the machine to achieve the greatest single-core throughput, however it has a slightly higher setup cost than the plain next_u32 or next_u64 methods.

The underlying instruction may fail for variety reasons (such as actual hardware failure or exhausted entropy), however the exact reason for the failure is not usually exposed.

This method will retry calling the instruction a few times, however if all the attempts fail, it will return an error.

If an error is returned, the caller should assume that an non-recoverable hardware failure has occured and use another random number genrator instead.

source§

impl Copy for RdRand

source§

impl CryptoRng for RdRand

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.