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
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
115
116
117
118

use alloc::string::String;
use alloc::vec::Vec;
use core::fmt::{Arguments, Write};

use crate::{
    AssertThat,
    details::{DetailMessages, WithDetail},
    prelude::Mode,
};

pub trait Failure {
    /// Writes the failure message to the target string.
    ///
    /// # Errors
    ///
    /// Returns a `core::fmt::Error` if writing to the target string fails.
    fn write_to(self, target: &mut String) -> core::fmt::Result;
}

impl Failure for &str {
    fn write_to(self, target: &mut String) -> core::fmt::Result {
        target.write_str(self)
    }
}

impl Failure for Arguments<'_> {
    fn write_to(self, target: &mut String) -> core::fmt::Result {
        target.write_fmt(self)
    }
}

impl<F> Failure for F
where
    F: FnOnce(&mut String) -> core::fmt::Result,
{
    fn write_to(self, target: &mut String) -> core::fmt::Result {
        self(target)
    }
}

pub(crate) trait Fallible {
    fn store_failure(&self, failure: String);
}

impl<T, M: Mode> Fallible for AssertThat<'_, T, M> {
    fn store_failure(&self, failure: String) {
        match &self.parent {
            Some(parent) => parent.store_failure(failure),
            None => self.failures.borrow_mut().push(failure),
        }
    }
}

impl<T, M: Mode> AssertThat<'_, T, M> {
    /// Records or raises a failure message.
    ///
    /// # Panics
    ///
    /// Panics with the formatted failure message when not in capture mode.
    #[track_caller]
    pub fn fail(&self, failure: impl Failure) {
        let mut detail_messages = Vec::new();
        self.collect_messages(&mut detail_messages);

        let msg = build_failure_message(
            self.print_location,
            self.subject_name.as_deref(),
            &detail_messages,
            failure,
        )
        .expect("no write error");

        // TODO: Check is_capture in root! Do not allow with_capture() on derived asserts.
        if self.mode.borrow().is_capture() {
            self.store_failure(msg);
        } else {
            panic!("{msg}");
        }
    }
}

#[track_caller]
fn build_failure_message(
    print_location: bool,
    subject_name: Option<&str>,
    detail_messages: &[String],
    failure: impl Failure,
) -> Result<String, core::fmt::Error> {
    let mut err = String::new();

    err.write_str("-------- assertr --------\n")?;

    if print_location {
        let caller_location = core::panic::Location::caller();
        let _ = err.write_fmt(format_args!(
            "Assertion failed at {file}:{line}:{column}\n\n",
            file = caller_location.file(),
            line = caller_location.line(),
            column = caller_location.column(),
        ));
    }

    if let Some(subject_name) = subject_name {
        err.write_fmt(format_args!("Subject: {subject_name}\n\n"))?;
    }

    failure.write_to(&mut err)?;

    if !detail_messages.is_empty() {
        err.write_str("\n")?;
        let detail_messages = DetailMessages(detail_messages);
        err.write_fmt(format_args!("Details: {detail_messages:#?}\n"))?;
    }

    err.write_str("-------- assertr --------\n")?;

    Ok(err)
}