assertr 0.5.6

Fluent assertions for the Rust programming language.
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

use alloc::borrow::ToOwned;
use alloc::string::String;
use alloc::vec::Vec;
use core::fmt::Debug;

use crate::{AssertThat, mode::Mode};

pub(crate) struct DetailMessages<'a>(pub(crate) &'a [String]);

impl Debug for DetailMessages<'_> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_list()
            .entries(self.0.iter().map(|it| DisplayString(it)))
            .finish()
    }
}

pub(crate) struct DisplayString<'a>(pub(crate) &'a str);

impl Debug for DisplayString<'_> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.write_str(self.0)
    }
}

pub(crate) trait WithDetail {
    fn collect_messages(&self, collection: &mut Vec<String>);
}

impl<T, M: Mode> WithDetail for AssertThat<'_, T, M> {
    fn collect_messages(&self, collection: &mut Vec<String>) {
        for m in self.detail_messages.borrow().iter() {
            collection.push(m.to_owned());
        }
        if let Some(parent) = self.parent {
            parent.collect_messages(collection);
        }
    }
}

impl<T, M: Mode> AssertThat<'_, T, M> {
    /// Add a message to be displayed on assertion failure.
    #[must_use]
    pub fn with_detail_message(self, message: impl Into<String>) -> Self {
        self.detail_messages.borrow_mut().push(message.into());
        self
    }

    /// Add a message to be displayed on assertion failure bound by the given condition.
    #[must_use]
    pub fn with_conditional_detail_message<Message: Into<String>>(
        self,
        condition: impl Fn(&Self) -> bool,
        message_provider: impl Fn(&Self) -> Message,
    ) -> Self {
        if condition(&self) {
            let message = message_provider(&self);
            self.detail_messages.borrow_mut().push(message.into());
        }
        self
    }

    /// Add a message to be displayed on assertion failure.
    ///
    /// Use this variant instead of the `with_` variants when not in a call-chain context,
    /// and you don't want to call an ownership-taking function.
    pub fn add_detail_message(&self, message: impl Into<String>) {
        self.detail_messages.borrow_mut().push(message.into());
    }
}