shoulds 0.3.0

An intuitive, fluent assertion library for writing expressive test expectations in Rust.
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

/// A wrapper type that provides fluent-style assertions for a given value.
///
/// Constructed using the [`Shouldable::should`] method.
pub struct Should<'a, T> {
    actual: &'a T,
}

/// Returns a reference to the underlying value.
///
/// This can be useful for writing custom assertions or debugging.
impl<'a, T> Should<'a, T> {
    pub fn actual(&self) -> &T {
        self.actual
    }
}

/// A trait implemented for all types to enable fluent assertions using [`Should<T>`].
///
/// Call `.should()` on any value to access fluent assertion methods:
///
/// ```
/// use shoulds::Shouldable;
///
/// let x = 42;
/// x.should().eq(&42);
/// ```
pub trait Shouldable<T> {
    fn should(&self) -> Should<T>;
}

impl<T> Shouldable<T> for T {
    fn should(&self) -> Should<T> {
        Should { actual: self }
    }
}