const-str 1.1.0

compile-time string operations
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use core::cmp::Ordering;

pub struct Compare<T1, T2>(pub T1, pub T2);

impl Compare<&[u8], &[u8]> {
    pub const fn const_eval(&self) -> Ordering {
        crate::bytes::compare(self.0, self.1)
    }
}

impl<const L1: usize, const L2: usize> Compare<&[u8; L1], &[u8; L2]> {
    pub const fn const_eval(&self) -> Ordering {
        crate::bytes::compare(self.0, self.1)
    }
}

impl Compare<&str, &str> {
    pub const fn const_eval(&self) -> Ordering {
        crate::str::compare(self.0, self.1)
    }
}

/// Compares two strings lexicographically.
///
/// This macro is [const-fn compatible](./index.html#const-fn-compatible).
///
/// See also [`equal!`](crate::equal).
///
/// # Examples
///
/// ```
/// use core::cmp::Ordering;
///
/// const A: &str = "1";
/// const B: &str = "10";
/// const C: &str = "2";
///
/// const ORD: Ordering = const_str::compare!(A, B);
/// assert_eq!(ORD, Ordering::Less);
///
/// assert!(const_str::compare!(<, A, B));
/// assert!(const_str::compare!(<=, A, B));
///
/// assert!(const_str::compare!(>, C, A));
/// assert!(const_str::compare!(>=, C, A));
///
/// assert!(const_str::compare!(==, A, A));
/// ```
///
#[macro_export]
macro_rules! compare {
    (<, $lhs: expr, $rhs: expr) => {{
        use ::core::cmp::Ordering;
        let ordering = $crate::__ctfe::Compare($lhs, $rhs).const_eval();
        matches!(ordering, Ordering::Less)
    }};
    (>, $lhs: expr, $rhs: expr) => {{
        use ::core::cmp::Ordering;
        let ordering = $crate::__ctfe::Compare($lhs, $rhs).const_eval();
        matches!(ordering, Ordering::Greater)
    }};
    (==, $lhs: expr, $rhs: expr) => {{
        use ::core::cmp::Ordering;
        let ordering = $crate::__ctfe::Compare($lhs, $rhs).const_eval();
        matches!(ordering, Ordering::Equal)
    }};
    (<=, $lhs: expr, $rhs: expr) => {{
        use ::core::cmp::Ordering;
        let ordering = $crate::__ctfe::Compare($lhs, $rhs).const_eval();
        matches!(ordering, Ordering::Less | Ordering::Equal)
    }};
    (>=, $lhs: expr, $rhs: expr) => {{
        use ::core::cmp::Ordering;
        let ordering = $crate::__ctfe::Compare($lhs, $rhs).const_eval();
        matches!(ordering, Ordering::Greater | Ordering::Equal)
    }};
    ($lhs: expr, $rhs: expr) => {
        $crate::__ctfe::Compare($lhs, $rhs).const_eval()
    };
}

#[cfg(test)]
mod tests {
    use core::cmp::Ordering;

    #[test]
    fn test_compare_str() {
        const A: &str = "apple";
        const B: &str = "banana";
        const C: &str = "apple";

        const ORD1: Ordering = compare!(A, B);
        const ORD2: Ordering = compare!(B, A);
        const ORD3: Ordering = compare!(A, C);

        assert_eq!(ORD1, Ordering::Less);
        assert_eq!(ORD2, Ordering::Greater);
        assert_eq!(ORD3, Ordering::Equal);

        let lt = compare!(<, A, B);
        let gt = compare!(>, B, A);
        let eq = compare!(==, A, C);
        let le1 = compare!(<=, A, B);
        let le2 = compare!(<=, A, C);
        let ge1 = compare!(>=, B, A);
        let ge2 = compare!(>=, A, C);

        assert!(lt);
        assert!(gt);
        assert!(eq);
        assert!(le1);
        assert!(le2);
        assert!(ge1);
        assert!(ge2);
    }

    #[test]
    fn test_compare_bytes() {
        const A: &[u8] = b"apple";
        const B: &[u8] = b"banana";
        const C: &[u8] = b"apple";

        const ORD1: Ordering = compare!(A, B);
        const ORD2: Ordering = compare!(B, A);
        const ORD3: Ordering = compare!(A, C);

        assert_eq!(ORD1, Ordering::Less);
        assert_eq!(ORD2, Ordering::Greater);
        assert_eq!(ORD3, Ordering::Equal);
    }

    #[test]
    fn test_compare_byte_arrays() {
        const A: &[u8; 5] = b"apple";
        const B: &[u8; 6] = b"banana";
        const C: &[u8; 5] = b"apple";

        const ORD1: Ordering = compare!(A, B);
        const ORD2: Ordering = compare!(B, A);
        const ORD3: Ordering = compare!(A, C);

        assert_eq!(ORD1, Ordering::Less);
        assert_eq!(ORD2, Ordering::Greater);
        assert_eq!(ORD3, Ordering::Equal);
    }

    #[test]
    fn test_compare_runtime() {
        use super::*;

        // Runtime tests for Compare with &str
        let cmp_str = Compare("apple", "banana");
        assert_eq!(cmp_str.const_eval(), Ordering::Less);

        let cmp_str2 = Compare("zebra", "apple");
        assert_eq!(cmp_str2.const_eval(), Ordering::Greater);

        let cmp_str3 = Compare("test", "test");
        assert_eq!(cmp_str3.const_eval(), Ordering::Equal);

        // Runtime tests for Compare with bytes
        let cmp_bytes = Compare(b"hello".as_slice(), b"world".as_slice());
        assert_eq!(cmp_bytes.const_eval(), Ordering::Less);

        // Runtime tests for Compare with byte arrays
        let arr1: &[u8; 3] = b"abc";
        let arr2: &[u8; 3] = b"xyz";
        let cmp_arr = Compare(arr1, arr2);
        assert_eq!(cmp_arr.const_eval(), Ordering::Less);
    }
}