diceprop 0.3.0

Mathematical properties for random testing
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

use std::fmt::Debug;

use dicetest::hint;

use crate::Eval;

/// Represents an element of type `S`.
#[derive(Clone, Copy)]
pub struct Elem<'a, S: Debug> {
    /// The human-readable name of the element.
    pub name: &'a str,
    value: S,
}

impl<'a, S: Debug> Elem<'a, S> {
    pub fn new(name: &'a str, value: S) -> Self {
        Self { name, value }
    }

    /// Returns an [`Eval`] that contains this element.
    ///
    /// This operation will log the element via [`dicetest::hints`].
    pub fn eval(self) -> Eval<&'a str, S> {
        hint!("{} = {:?}", self.name, self.value);

        Eval {
            label: self.name,
            value: self.value,
        }
    }

    /// Returns an [`Elem`] with the same name and a reference to the original value.
    pub fn as_ref(&self) -> Elem<'_, &S> {
        Elem::new(self.name, &self.value)
    }
}

impl<'a, S: Debug> Elem<'a, &S> {
    /// Returns an [`Elem`] with the same name and a clone of the original value.
    pub fn cloned(self) -> Elem<'a, S>
    where
        S: Clone,
    {
        Elem::new(self.name, self.value.clone())
    }

    /// Returns an [`Elem`] with the same name and a copy of the original value.
    pub fn copied(self) -> Elem<'a, S>
    where
        S: Copy,
    {
        Elem::new(self.name, *self.value)
    }
}