bc-rand 0.5.0

Blockchain Commons Random Number Utilities.
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
64
65
66
67

#![doc(html_root_url = "https://docs.rs/bc-rand/0.5.0")]
#![warn(rust_2018_idioms)]

//! # Blockchain Commons Random Number Utilities
//!
//!
//! `bc-rand` exposes a uniform API for the random number primitives used
//! in higher-level [Blockchain Commons](https://blockchaincommons.com)
//! projects, including a cryptographically strong random number generator
//! [`SecureRandomNumberGenerator`] and a deterministic random number generator
//! [`SeededRandomNumberGenerator`].
//!
//! These primitive random number generators implement the
//! [`RandomNumberGenerator`] trait to produce random numbers compatible with
//! the `RandomNumberGenerator` Swift protocol used in MacOS and iOS, which is
//! important when using the deterministic random number generator for
//! cross-platform testing.
//!
//! The crate also includes several convenience functions for generating secure
//! and deterministic random numbers.

mod magnitude;
mod widening;

mod random_number_generator;
use rand::RngCore;
pub use random_number_generator::{
    RandomNumberGenerator, rng_fill_random_data, rng_next_in_closed_range,
    rng_next_in_range, rng_next_with_upper_bound, rng_random_array,
    rng_random_bool, rng_random_data, rng_random_u32,
};

mod secure_random;
pub use secure_random::{
    SecureRandomNumberGenerator, fill_random_data, random_data,
};

mod seeded_random;
pub use seeded_random::{
    SeededRandomNumberGenerator, fake_random_data,
    make_fake_random_number_generator,
};

impl RandomNumberGenerator for rand::rngs::ThreadRng {
    fn random_data(&mut self, size: usize) -> Vec<u8> {
        let mut data = vec![0u8; size];
        self.fill_random_data(&mut data);
        data
    }

    fn fill_random_data(&mut self, data: &mut [u8]) { self.fill_bytes(data); }
}

pub fn thread_rng() -> rand::rngs::ThreadRng { rand::rng() }

#[cfg(test)]
mod tests {
    #[test]
    fn test_readme_deps() {
        version_sync::assert_markdown_deps_updated!("README.md");
    }

    #[test]
    fn test_html_root_url() {
        version_sync::assert_html_root_url_updated!("src/lib.rs");
    }
}