stefans-utils 0.12.0

A collection of useful Rust utility functions, types, and traits.
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

use crate::comparator::Comparison;
use core::{error::Error, fmt};

pub trait ExpectComparison: PartialOrd + PartialEq + Sized {
    fn expect_lt(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>>;
    fn expect_lte(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>>;
    fn expect_eq(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>>;
    fn expect_ne(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>>;
    fn expect_gte(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>>;
    fn expect_gt(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>>;
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
#[cfg_attr(feature = "schemars", derive(::schemars::JsonSchema))]
pub struct ExpectedComparisonError<T> {
    pub comparison: Comparison,
    pub comparator: T,
    pub actual: T,
}

impl<T: fmt::Debug> Error for ExpectedComparisonError<T> {}

impl<T: fmt::Debug> fmt::Display for ExpectedComparisonError<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!(
            "Expected value to be {} {:?}, but it was {:?}",
            self.comparison, self.comparator, self.actual
        ))
    }
}

impl Comparison {
    pub fn expect_comparison<T: PartialOrd + PartialEq>(
        &self,
        actual: T,
        comparator: T,
    ) -> Result<T, ExpectedComparisonError<T>> {
        if self.compare(&actual, &comparator) {
            Ok(actual)
        } else {
            Err(ExpectedComparisonError {
                comparison: *self,
                comparator,
                actual,
            })
        }
    }
}

impl<T: PartialOrd + PartialEq + Sized> ExpectComparison for T {
    fn expect_lt(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>> {
        Comparison::Less.expect_comparison(self, other)
    }

    fn expect_lte(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>> {
        Comparison::LessOrEqual.expect_comparison(self, other)
    }

    fn expect_eq(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>> {
        Comparison::Equal.expect_comparison(self, other)
    }

    fn expect_ne(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>> {
        Comparison::Unequal.expect_comparison(self, other)
    }

    fn expect_gte(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>> {
        Comparison::GreaterOrEqual.expect_comparison(self, other)
    }

    fn expect_gt(self, other: Self) -> Result<Self, ExpectedComparisonError<Self>> {
        Comparison::Greater.expect_comparison(self, other)
    }
}