expected 0.0.1

An assertion utility focused on unit 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
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use std::{any::Any, fmt};

/// A set of `Disappoint`s occurred during an execution of `expected`.
#[derive(Debug)]
pub struct Disappoints(pub Vec<Disappoint>);

impl std::ops::Deref for Disappoints {
    type Target = [Disappoint];

    #[inline]
    fn deref(&self) -> &Self::Target {
        &*self.0
    }
}

impl fmt::Display for Disappoints {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "one or more expectations have been disappointed:")?;
        for disappoint in &self.0 {
            writeln!(f, "{}", disappoint)?;
        }
        Ok(())
    }
}

impl IntoIterator for Disappoints {
    type Item = Disappoint;
    type IntoIter = std::vec::IntoIter<Disappoint>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.0.into_iter()
    }
}

impl<'a> IntoIterator for &'a Disappoints {
    type Item = &'a Disappoint;
    type IntoIter = std::slice::Iter<'a, Disappoint>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.0.iter()
    }
}

/// A struct providing information about a disappointing expectation.
#[derive(Debug)]
pub struct Disappoint {
    payload: Box<dyn Any + Send + 'static>,
    file: &'static str,
    line: u32,
    column: u32,
}

impl fmt::Display for Disappoint {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let payload = self.payload_str().unwrap_or("Box<dyn Any>");
        writeln!(
            f,
            "[{}:{}:{}] {}",
            self.file, self.line, self.column, payload,
        )
    }
}

impl Disappoint {
    #[inline]
    pub(crate) fn new(
        payload: Box<dyn Any + Send>,
        file: &'static str,
        line: u32,
        column: u32,
    ) -> Self {
        Self {
            payload,
            file,
            line,
            column,
        }
    }

    pub(crate) fn payload_str(&self) -> Option<&str> {
        let payload = self.payload();
        (payload.downcast_ref::<&str>().copied())
            .or_else(|| payload.downcast_ref::<String>().map(|s| s.as_str()))
    }

    /// Return the payload associated with the disappointment.
    ///
    /// The concrete type of payloads is commonly either of `&'static str`
    /// or `String`, but it may change in the future version.
    #[inline]
    pub fn payload(&self) -> &(dyn Any + Send + 'static) {
        &*self.payload
    }

    /// Return the name of the source file from which the disappointment originated.
    #[inline]
    pub fn file(&self) -> &str {
        self.file
    }

    /// Return the line number from which the disappointment originated.
    #[inline]
    pub fn line(&self) -> u32 {
        self.line
    }

    /// Return the column from which the disappointment originated.
    #[inline]
    pub fn column(&self) -> u32 {
        self.column
    }
}