Struct rand::rngs::adapter::ReadRng

source ·
pub struct ReadRng<R> { /* private fields */ }
Expand description

An RNG that reads random bytes straight from any type supporting std::io::Read, for example files.

This will work best with an infinite reader, but that is not required.

This can be used with /dev/urandom on Unix but it is recommended to use OsRng instead.

Panics

ReadRng uses std::io::Read::read_exact, which retries on interrupts. All other errors from the underlying reader, including when it does not have enough data, will only be reported through try_fill_bytes. The other RngCore methods will panic in case of an error.

Example

use rand::Rng;
use rand::rngs::adapter::ReadRng;

let data = vec![1, 2, 3, 4, 5, 6, 7, 8];
let mut rng = ReadRng::new(&data[..]);
println!("{:x}", rng.gen::<u32>());

Implementations§

source§

impl<R: Read> ReadRng<R>

source

pub fn new(r: R) -> ReadRng<R>

Create a new ReadRng from a Read.

Trait Implementations§

source§

impl<R: Debug> Debug for ReadRng<R>

source§

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

Formats the value using the given formatter. Read more
source§

impl<R: Read> RngCore for ReadRng<R>

source§

fn next_u32(&mut self) -> u32

Return the next random u32. Read more
source§

fn next_u64(&mut self) -> u64

Return the next random u64. Read more
source§

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

Fill dest with random data. Read more
source§

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

Fill dest entirely with random data. Read more

Auto Trait Implementations§

§

impl<R> RefUnwindSafe for ReadRng<R>where R: RefUnwindSafe,

§

impl<R> Send for ReadRng<R>where R: Send,

§

impl<R> Sync for ReadRng<R>where R: Sync,

§

impl<R> Unpin for ReadRng<R>where R: Unpin,

§

impl<R> UnwindSafe for ReadRng<R>where R: UnwindSafe,

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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<R> Rng for Rwhere R: RngCore + ?Sized,

source§

fn gen<T>(&mut self) -> Twhere Standard: Distribution<T>,

Return a random value supporting the Standard distribution. Read more
source§

fn gen_range<T: SampleUniform, B1, B2>(&mut self, low: B1, high: B2) -> Twhere B1: SampleBorrow<T> + Sized, B2: SampleBorrow<T> + Sized,

Generate a random value in the range [low, high), i.e. inclusive of low and exclusive of high. Read more
source§

fn sample<T, D: Distribution<T>>(&mut self, distr: D) -> T

Sample a new value, using the given distribution. Read more
source§

fn sample_iter<T, D>(self, distr: D) -> DistIter<D, Self, T> where D: Distribution<T>, Self: Sized,

Create an iterator that generates values using the given distribution. Read more
source§

fn fill<T: AsByteSliceMut + ?Sized>(&mut self, dest: &mut T)

Fill dest entirely with random bytes (uniform value distribution), where dest is any type supporting AsByteSliceMut, namely slices and arrays over primitive integer types (i8, i16, u32, etc.). Read more
source§

fn try_fill<T: AsByteSliceMut + ?Sized>( &mut self, dest: &mut T ) -> Result<(), Error>

Fill dest entirely with random bytes (uniform value distribution), where dest is any type supporting AsByteSliceMut, namely slices and arrays over primitive integer types (i8, i16, u32, etc.). Read more
source§

fn gen_bool(&mut self, p: f64) -> bool

Return a bool with a probability p of being true. Read more
source§

fn gen_ratio(&mut self, numerator: u32, denominator: u32) -> bool

Return a bool with a probability of numerator/denominator of being true. I.e. gen_ratio(2, 3) has chance of 2 in 3, or about 67%, of returning true. If numerator == denominator, then the returned value is guaranteed to be true. If numerator == 0, then the returned value is guaranteed to be false. 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.
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.
source§

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

Performs the conversion.
source§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V