heckcheck 2.0.1

A heckin small test case generator
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

/// Test case shrinking.
pub trait Shrink {
    /// Start shrinking the provided data.
    fn shrink(source: Vec<u8>) -> Self;

    /// Get the next test case.
    fn next(&mut self) -> &[u8];

    /// Report to the shrinker whether the last shrunk case passed or failed.
    ///
    /// Returns the final shrinkage case if no more cases are left to report.
    #[must_use = "The shrunk test case must be handled"]
    fn report(&mut self, report: ShrinkReport) -> Option<&[u8]>;
}

/// The result of a shrinking pass.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum ShrinkReport {
    /// The last test passed.
    Pass,
    /// The last test failed.
    Fail,
}

impl ShrinkReport {
    /// Returns `true` if the shrink_result is [`Pass`].
    ///
    /// [`Pass`]: ShrinkReport::Pass
    pub fn is_pass(&self) -> bool {
        matches!(self, Self::Pass)
    }

    /// Returns `true` if the shrink_result is [`Fail`].
    ///
    /// [`Fail`]: ShrinkReport::Fail
    pub fn is_fail(&self) -> bool {
        matches!(self, Self::Fail)
    }
}

impl<T> From<std::thread::Result<T>> for ShrinkReport {
    fn from(res: std::thread::Result<T>) -> Self {
        match res {
            Ok(_) => ShrinkReport::Pass,
            Err(_) => ShrinkReport::Fail,
        }
    }
}