rnd 0.1.1

Random
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(unix)]
pub mod unix;
pub mod mt19937;
pub mod dist;
mod impls;

/// A source of randomness
pub trait RandomSource {
    /// Fills the given buffer of bytes
    ///
    /// # Example
    /// ```
    /// use rnd::RandomSource;
    ///
    /// fn rand(source: &mut dyn RandomSource) -> u32 {
    ///     let mut bytes = [0; 4];
    ///     source.fill_bytes(&mut bytes);
    ///     u32::from_le_bytes(bytes)
    /// }
    /// ```
    fn fill_bytes(&mut self, bytes: &mut [u8]);
}

/// A type that can be randomly generated.
///
/// # Example
/// ```
/// use rnd::{Random, RandomSource};
///
/// struct Point {
///     x: u32,
///     y: u32
/// }
///
/// impl Random for Point {
///     fn random<S>(source: &mut S) -> Self
///     where
///         S: RandomSource + ?Sized
///     {
///         Point {
///             x: u32::random(source),
///             y: u32::random(source),
///         }
///     }
/// }
/// ```
pub trait Random: Sized {
    fn random<S>(source: &mut S) -> Self
    where
        S: RandomSource + ?Sized;
}

/// Trait for `seedable` types.
pub trait Seedable<S> {
    fn reseed(&mut self, seed: S);
}

#[cfg(feature = "std")]
mod global;
#[cfg(feature = "std")]
pub use global::{random, set_global_random, GlobalRandomSource};