vitaminc-random 0.2.0-pre.1

Secure Random Number Generation. Part of the Vitamin-C cryptographic suite.
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

#![doc = include_str!("../README.md")]
use thiserror::Error;
mod bounded;
mod generatable;
mod safe_rand;

pub use bounded::BoundedRng;
#[doc(inline)]
pub use generatable::Generatable;
pub use safe_rand::SafeRand;

// Re-exports
pub use rand::{Fill, Rng, SeedableRng};

/// Derive macro for `Generatable`
pub use vitaminc_random_derives::Generatable;

#[derive(Error, Debug)]
pub enum RandomError {
    #[error("Generation failed")]
    GenerationFailed,
    #[error("Seeding from OS RNG failed: {0}")]
    SeedingFailed(#[from] rand::rngs::SysError),
}

#[cfg(test)]
mod tests {
    use super::{Generatable, SafeRand};
    use std::num::NonZeroU16;

    #[test]
    fn test_generate_nonzerou16() -> Result<(), crate::RandomError> {
        let mut rng = SafeRand::from_entropy()?;
        let value: NonZeroU16 = Generatable::random(&mut rng)?;
        assert_ne!(value.get(), 0);
        Ok(())
    }
}