[][src]Struct rand::rngs::adapter::ReadRng

pub struct ReadRng<R> { /* fields omitted */ }

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>());

Methods

impl<R: Read> ReadRng<R>[src]

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

Create a new ReadRng from a Read.

Trait Implementations

impl<R: Debug> Debug for ReadRng<R>[src]

impl<R: Read> RngCore for ReadRng<R>[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<R> Rng for R where
    R: RngCore + ?Sized
[src]

fn gen<T>(&mut self) -> T where
    Standard: Distribution<T>, 
[src]

Return a random value supporting the [Standard] distribution. Read more

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

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

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

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

Important traits for DistIter<D, R, T>
fn sample_iter<T, D>(self, distr: D) -> DistIter<D, Self, T> where
    D: Distribution<T>,
    Self: Sized
[src]

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

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

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

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

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

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

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

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

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

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]