sweet 0.4.2

A delightful cross-platform test runner
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

//! These are assertions designed to be called directly from matchers,
//! Must be called at [`SweetError::BACKTRACE_LEVEL_3`],
//! exactly two levels below the expression that should have its frame
//! captured by the backtrace.
use std::fmt::Debug;
use std::fmt::Display;

use crate::prelude::*;


/// Panics if the result is false
pub fn assert(result: bool, msg: impl AsRef<str>) {
	if !result {
		panic_ext::panic_str(msg);
	}
}

/// Panics at correct backtrace level
pub fn panic(msg: impl AsRef<str>) { panic_ext::panic_str(msg); }



/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn panic_expected_received_display<T1: Display, T2: Display>(
	expected: T1,
	received: T2,
) -> ! {
	panic_ext::panic_expected_received_display(expected, received)
}
/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn panic_expected_received_debug<T1: Debug, T2: Debug>(
	expected: T1,
	received: T2,
) -> ! {
	panic_ext::panic_expected_received_debug(expected, received)
}
/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn panic_expected_received_debug_display<T1: Debug, T2: Display>(
	expected: T1,
	received: T2,
) -> ! {
	panic_ext::panic_expected_received_debug_display(expected, received)
}
/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn panic_expected_received_display_debug<T1: Display, T2: Debug>(
	expected: T1,
	received: T2,
) -> ! {
	panic_ext::panic_expected_received_display_debug(expected, received)
}

/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn assert_expected_received_display<Expected: Display, Received: Display>(
	expected: Expected,
	received: impl IntoMaybeNotDisplay<Received>,
) where
	Received: PartialEq<Expected>,
{
	let received = received.into_maybe_not();
	if let Err(expected) = received.compare_display(&expected) {
		panic_ext::panic_expected_received_display(&expected, received.inner());
	}
}

/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn assert_expected_received_debug<T1: Debug, T2: PartialEq<T1> + Debug>(
	expected: T1,
	received: impl IntoMaybeNotDisplay<T2>,
) {
	let received = received.into_maybe_not();
	if let Err(expected) = received.compare_debug(&expected) {
		panic_ext::panic_expected_received_display_debug(&expected, &received);
	}
}
/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn assert_result_expected_received_display<
	Expected: Display,
	Received: Display,
>(
	result: bool,
	expected: Expected,
	received: MaybeNot<Received>,
) -> MaybeNot<Received> {
	if let Err(expected) = received.passes_display(result, &expected) {
		panic_ext::panic_expected_received_display(&expected, received.inner());
	}
	received
}


/// Panics if the values are not equal
pub fn assert_diff<Received: AsRef<str>>(
	expected: impl AsRef<str>,
	received: MaybeNot<Received>,
) -> MaybeNot<Received> {
	let expected = expected.as_ref();
	let received_str = received.inner().as_ref();
	let is_match = expected == received_str;
	match (is_match, received.is_negated()) {
		(true, false) => received,
		(false, true) => received,
		(true, true) => {
			panic_ext::panic_expected_received_display(
				"NOT to be string",
				received_str,
			);
		}
		(false, false) => {
			panic_ext::panic_str(&crate::utils::pretty_diff::inline_diff(
				expected,
				received_str,
			));
		}
	}
}


/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn assert_some_with_received_display<T>(received: Option<T>)
where
	Option<T>: Display,
{
	if received.is_none() {
		panic_ext::panic_expected_received_display(&"Some", &received);
	}
}

/// Must be called at [`SweetError::BACKTRACE_LEVEL_3`]
pub fn assert_none_with_received_display<T>(received: Option<T>)
where
	Option<T>: Display,
{
	if received.is_some() {
		panic_ext::panic_expected_received_display(&"None", &received);
	}
}