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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

//! Assure: macros for Rust runtime checking
//!
//! This Rust crate provides the macro `assure!` and related macros.
//!
//! These are intentionally similar to the macro `assert!` and related macros.
//!
//! Available via [https://crates.io/crates/assure](https://crates.io/crates/assure)
//!
//!
//! # Introduction
//!
//! The `assure` macros work like this:
//!
//! * `assure!(x)` returns `Result` with `Ok(x)` or `Err("assure")`.
//!
//! * `assure_eq(x, y)` returns `Result` with `Ok(x)` or `Err("assure_eq left:1 right:2"))`.
//!
//! For comparison `assert` macros work like this:
//!
//! * `assert!(x)` returns successfully or calls `panic!`.
//!
//! * `assert_eq!(x, y)` returns successfully or calls `panic!`.
//!
//!
//! # Return Ok or Err
//!
//! The `assure` macros return `Result` with either:
//!
//! * `Ok(…)` with the leftmost macro argument.
//!
//! * `Err(…)` with a generated error message intended for diagnostics.
//!
//! Example of `Ok`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = 1;
//! let b = 1;
//! assure_eq!(a, b);
//! //-> Ok(a)
//! # }
//! ```
//!
//! Example of `Err`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = 1;
//! let b = 2;
//! assure_eq!(a, b);
//! //-> Err("assure_eq left:1 right:2")
//! # }
//! ```
//!
//!
//! # Usage
//!
//! The `assure` macros can useful for checking with the `?` operator.
//!
//! This example function uses the `assure_gt!` macro, which means assure greater than:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! fn sum_positive_numbers(a: i32, b: i32) -> Result<i32, String> {
//!     assure_gt!(a, 0)?;
//!     assure_gt!(b, 0)?;
//!     Ok(a + b)
//! }
//!
//! sum_positive_numbers(1, 2);
//! //-> Ok(3)
//!
//! sum_positive_numbers(1, -2);
//! //-> Err("assure_gt left:-2 right:0)
//! # }
//! ```
//!
//!
//! # Custom error messages
//!
//! The `assure` macros generate a defult diagnostic error message such as:
//!
//! * `assure_eq!(1, 2)` returns `Err("assure_eq left:1 right:2")`.
//!
//! The macros have a second form, where a custom error message can be provided
//!  as the last argument:
//!
//! * `assure_eq!(1, 2, "message")` returns `Err("message")`.
//!
//! Example error message:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! fn sum_positive_numbers(a: i32, b: i32) -> Result<i32, String> {
//!     assure_gt!(a, 0, "param 1 must be postive but is {}", a)?;
//!     assure_gt!(b, 0, "param 2 must be postive but is {}", b)?;
//!     Ok(a + b)
//! }
//! # }
//! ```
//!
//!
//! # Macros for simple values
//!
//! Macro for truth checking:
//!
//! * [`assure!`]`(a)`: assure `a` is true.
//!
//! Macros for value comparison:
//!
//! * [`assure_eq!`]`(a, b)`: assure `a` is equal to `b`.
//!
//! * [`assure_ne!`]`(a, b)`: assure `a` is not equal to `b`.
//!
//! * [`assure_lt!`]`(a, b)`: assure `a` is less than `b`.
//!
//! * [`assure_le!`]`(a, b)`: assure `a` is less than or equal to `b`.
//!
//! * [`assure_gt!`]`(a, b)`: assure `a` is greater than `b`.
//!
//! * [`assure_ge!`]`(a, b)`: assure `a` is greater than or equal to `b`.
//!
//!
//! # Macros for set checking
//!
//! The `assure_set…!` macros help with comparison of set parameters, such as two arrays or two vectors. where the item order does not matter, and the item count does not matter.
//!
//! * [`assure_set_eq`]`(a, b)`: assure the set `a` is equal to the set `b`.
//!
//! * [`assure_set_ne`]`(a, b)`: assure the set `a` is not equal to the set `b`.
//!
//! Example of `Ok`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = [1, 2];
//! let b = [2, 1];
//! assure_set_eq!(&a, &b);
//! //-> Ok(&a)
//! # }
//! ```
//!
//! Example of `Err`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = [1, 2];
//! let b = [3, 4];
//! assure_set_eq!(&a, &b);
//! //-> Err("assure_set_eq left:{1, 2} right:{3, 4}")
//! # }
//! ```
//!
//!
//! # Macros for bag checking
//!
//! The `assure_bag…!` macros help with comparison of bag parameters, such as comparison of two arrays or two vectors, where the item order does not matter, and the item count does matter.
//!
//! * [`assure_bag_eq`]`(a, b)`: assure the bag `a` is equal to the bag `b`.
//!
//! * [`assure_bag_ne`]`(a, b)`: assure the bag `a` is not equal to the bag `b`.
//!
//! Example of `Ok`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = [1, 1];
//! let b = [1, 1];
//! assure_set_eq!(&a, &b);
//! //-> Ok(&a)
//! # }
//! ```
//!
//! Example of `Err`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = [1, 1];
//! let b = [1, 1, 1];
//! assure_set_eq!(&a, &b);
//! //-> Err("assure_bag_eq left:{1: 2} right:{1: 3}")
//! # }
//! ```
//!
//!
//! # Macros for IO-related checking
//!
//! The `assure_io…!` macros help with IO-related checking, such as comparison of files, streams, etc. These macros return a `Result` with `Ok(true)` or `Err(std::io::Error::new(std::io::ErrorKind::InvalidInput, message))`.
//!
//! Macro for truth checking:
//!
//! * [`assure_io!`]`(a)`: assure `a` is true.
//!
//! Macros for value comparison:
//!
//! * [`assure_io_eq!`]`(a, b)`: assure `a` is equal to `b`.
//!
//! * [`assure_io_ne!`]`(a, b)`: assure `a` is not equal to `b`.
//!
//! * [`assure_io_lt!`]`(a, b)`: assure `a` is less than `b`.
//!
//! * [`assure_io_le!`]`(a, b)`: assure `a` is less than or equal to `b`.
//!
//! * [`assure_io_gt!`]`(a, b)`: assure `a` is greater than `b`.
//!
//! * [`assure_io_ge!`]`(a, b)`: assure `a` is greater than or equal to `b`.
//!
//! Example of `Ok`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = 1;
//! let b = 1;
//! assure_io_eq!(a, b);
//! //-> Ok(a)
//! # }
//! ```
//!
//! Example of `Err`:
//!
//! ```rust
//! # #[macro_use] extern crate assure; fn main() {
//! let a = 1;
//! let b = 2;
//! assure_io_eq!(a, b);
//! //-> Err(std::io::Error::new(
//!          std::io::ErrorKind::InvalidInput, 
//!          "assure_io_eq left:1 right:2"
//!      ))
//! # }
//! ```

// Assure truth
pub mod assure;

// Assure value comparison
pub mod assure_eq; // equal
pub mod assure_ne; // not equal
pub mod assure_lt; // less than
pub mod assure_le; // less than or equal to
pub mod assure_gt; // greater than
pub mod assure_ge; // greater than or equal to

// Assure iterator-related set-based comparison
pub mod assure_set_eq; // equal
pub mod assure_set_ne; // not equal

// Assure iterator-related bag-based comparison
pub mod assure_bag_eq; // equal
pub mod assure_bag_ne; // not equal

// Assure IO-related truth, which can return Err(std:io:Error(…))
pub mod assure_io;

// Assure IO-related comparison, which can return Err(std:io:Error(…))
pub mod assure_io_eq; // equal
pub mod assure_io_ne; // not equal
pub mod assure_io_lt; // less than
pub mod assure_io_le; // less than or equal to
pub mod assure_io_gt; // greater than
pub mod assure_io_ge; // greater than or equal to