quantor 0.10.1

Declarative quantifiers for filtering, validation, and testing 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
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
172
173
174
175
176

//! # quantor: Assertions
//!
//! This module provides macros for validating logical properties of sequences at runtime.
//! All macros panic on failure and are suitable for use in tests or precondition enforcement.
//!
//! ## Available Macros
//!
//! - [`assert_forall!`] - Ensures all elements satisfy a predicate
//! - [`assert_exists!`] - Ensures at least one element satisfies a predicate
//! - [`assert_unique!`] - Ensures all elements are unique
//! - [`assert_duplicates!`] - Ensures at least one duplicate is present
//! - [`assert_pairwise!`] - Ensures a binary predicate holds for all adjacent pairs

/// Asserts that all elements in the collection satisfy the given predicate.
/// ## Example
/// ```
/// use quantor::assert_forall;
/// 
/// let numbers = vec!(0, 2, 4, 6);
/// 
/// assert_forall!(&numbers, |x| x % 2 == 0);
/// ```
#[macro_export]
macro_rules! assert_forall {
    ($iter:expr, $pred:expr) => {{
        match $crate::quantifiers::basic::forall($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_forall! failed: {}", e),
        }
    }};
    ($iter:expr, $pred:expr, $($msg:tt)+) => {{
        match $crate::quantifiers::basic::forall($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_forall! failed: {} — {}", format_args!($($msg)+), e),
        }
    }};
}
/// Asserts that at least one element satisfies the predicate.
/// ## Example
/// ```
/// use quantor::assert_exists;
/// 
/// let numbers = vec!(0, 1, 3, 5);
/// 
/// assert_exists!(&numbers, |x| x % 2 == 0);
/// ```
#[macro_export]
macro_rules! assert_exists {
    ($iter:expr, $pred:expr) => {{
        match $crate::quantifiers::basic::exists($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_exists! failed: {}", e),
        }
    }};
    ($iter:expr, $pred:expr, $($msg:tt)+) => {{
        match $crate::quantifiers::basic::exists($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_exists! failed: {} — {}", format_args!($($msg)+), e),
        }
    }};
}

/// Asserts that at least one element satisfies the predicate.
/// ## Example
/// ```
/// use quantor::assert_exactly_n;
/// 
/// let numbers = vec!(0, 1, 3, 5);
/// 
/// assert_exactly_n!(&numbers, 1, |x| x % 2 == 0);
/// ```
#[macro_export]
macro_rules! assert_exactly_n {
    ($iter:expr, $count:expr, $pred:expr) => {{
        match $crate::quantifiers::basic::exactly_n($iter, $count, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_exactly_n! failed: {}", e),
        }
    }};
}
/// Asserts that no elements in the iterable satisfy the given predicate.
///
/// ## Example
/// ```
/// use quantor::assert_none;
///
/// let values = vec![1, 3, 5];
/// assert_none!(&values, |x| x % 2 == 0);
/// ```
#[macro_export]
macro_rules! assert_none {
    ($iter:expr, $pred:expr) => {{
        match $crate::quantifiers::basic::none($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_none! failed: {}", e),
        }
    }};
    ($iter:expr, $pred:expr, $($msg:tt)+) => {{
        match $crate::quantifiers::basic::none($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_none! failed: {} — {}", format_args!($($msg)+), e),
        }
    }};
}
/// Asserts that all elements are unique.
/// ## Example
/// ```
/// use quantor::assert_unique;
/// 
/// let numbers = vec!(0, 1, 2, 3);
/// 
/// assert_unique!(&numbers);
/// ```
#[macro_export]
macro_rules! assert_unique {
    ($iter:expr) => {{
        let all_unique = $crate::select_duplicates($iter).is_empty();
        assert!(all_unique, "assert_unique! failed: duplicate elements found.");
    }};
    ($iter:expr, $($msg:tt)+) => {{
        use std::collections::HashSet;
        let mut set = HashSet::new();
        let mut all_unique = true;
        for item in $iter {
            if !set.insert(item) {
                all_unique = false;
                break;
            }
        }
        assert!(all_unique, $($msg)+);
    }};
}
/// Asserts that the input contains at least one duplicate.
/// ## Example
/// ```
/// use quantor::assert_duplicates;
/// 
/// let numbers = vec!(0, 0, 1, 2);
/// 
/// assert_duplicates!(&numbers);
/// ```
#[macro_export]
macro_rules! assert_duplicates {
    ($iter:expr) => {{
        let has_duplicates = !$crate::select_duplicates($iter).is_empty();
        assert!(has_duplicates, "assert_duplicates! failed: no duplicates found.");
    }};
    ($iter:expr, $($msg:tt)+) => {{
        let has_duplicates = !$crate::select_duplicates($iter).is_empty();
        assert!(has_duplicates, $($msg)+);
    }};
}
/// Asserts that a binary predicate holds for every adjacent pair in a sequence.
/// ## Example
/// ```
/// use quantor::assert_pairwise;
/// 
/// let numbers = vec!(0, 1, 2, 3);
/// 
/// assert_pairwise!(&numbers, |a, b| a < b );
/// ```
#[macro_export]
macro_rules! assert_pairwise {
    ($iter:expr, $pred:expr) => {{
        match $crate::quantifiers::structured::pairwise($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_pairwise! failed: {}", e),
        }
    }};
    ($iter:expr, $pred:expr, $($msg:tt)+) => {{
        match $crate::quantifiers::structured::pairwise($iter, $pred) {
            Ok(()) => {},
            Err(e) => panic!("assert_pairwise! failed: {} — {}", format_args!($($msg)+), e),
        }
    }};
}