dicetest 0.4.0

Framework for writing tests with randomly generated test data
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use crate::dice::{CollectionBuilder, LengthRange};
use crate::prelude::*;
use std::collections::VecDeque;

/// [`VecDeque`] builder for [`dice::collection`].
///
/// [`dice::collection`]: dice::collection()
pub struct VecDequeBuilder;

impl<T> CollectionBuilder<T, VecDeque<T>> for VecDequeBuilder {
    fn build(&self, elems: impl ExactSizeIterator<Item = T>) -> VecDeque<T> {
        let mut vec = VecDeque::with_capacity(elems.len());
        vec.extend(elems);
        vec
    }
}

/// Generates a [`VecDeque`] that contains elements of type `T`.
///
/// The range specifies the length of the [`VecDeque`].
///
/// # Panics
///
/// Panics if the range is empty.
///
/// # Examples
///
/// ```
/// use dicetest::prelude::*;
/// use dicetest::{Prng, Limit};
///
/// let mut prng = Prng::from_seed(0x5EED.into());
/// let limit = Limit::default();
/// let mut fate = Fate::new(&mut prng, limit);
///
/// let elem_die = dice::u8(..);
///
/// let vec = fate.with_limit(100.into()).roll(dice::vec_deque(&elem_die, ..));
/// assert!(vec.len() <= 100);
///
/// let vec = fate.roll(dice::vec_deque(&elem_die, ..=73));
/// assert!(vec.len() <= 73);
///
/// let vec = fate.roll(dice::vec_deque(&elem_die, 17..));
/// assert!(vec.len() >= 17);
///
/// let vec = fate.roll(dice::vec_deque(&elem_die, 42));
/// assert!(vec.len() == 42);
/// ```
pub fn vec_deque<T>(
    elem_die: impl Die<T>,
    length_range: impl LengthRange,
) -> impl Die<VecDeque<T>> {
    dice::collection(VecDequeBuilder, elem_die, length_range)
}

/// Similar to [`dice::vec_deque`] but each element is generated using only a random part of
/// [`Limit`].
///
/// If you want to generate a [`VecDeque]` that contains other collections, then you should
/// consider using this generator for the outer [`VecDeque`]. That way the overall length is
/// bounded by [`Limit`] (and not the square of [`Limit`]).
///
/// [`Limit`]: crate::Limit
/// [`dice::vec_deque`]: dice::vec_deque()
///
/// # Panics
///
/// Panics if the range is empty.
///
/// # Examples
///
/// ```
/// use dicetest::prelude::*;
/// use dicetest::{Prng, Limit};
///
/// let mut prng = Prng::from_seed(0x5EED.into());
/// let limit = Limit::default();
/// let mut fate = Fate::new(&mut prng, limit);
///
/// let elem_die = dice::u8(..);
/// let vec_die = dice::vec_deque(elem_die, ..);
/// let vec_of_vecs_die = dice::outer_vec_deque(vec_die, ..);
///
/// let vec_of_vecs = fate.roll(vec_of_vecs_die);
/// assert!(vec_of_vecs.iter().flatten().count() <= 100);
/// ```
pub fn outer_vec_deque<T>(
    elem_die: impl Die<T>,
    length_range: impl LengthRange,
) -> impl Die<VecDeque<T>> {
    dice::outer_collection(VecDequeBuilder, elem_die, length_range)
}