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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
//! Assertables: Rust crate of macros `assert`, `assume`, `assure` //! //! This `assertables` Rust crate provides macros //! `assert…!`, `assume…!`, `assure…!`, all for runtime //! reliability checking, and all described below. By SixArm.com. //! //! Crate: [https://crates.io/crates/assure](https://crates.io/crates/assure) //! //! Docs: [https://docs.rs/assure/](https://docs.rs/assure/) //! //! Repo: [https://github.com/joelparkerhenderson/assure-rust-crate/](https://github.com/joelparkerhenderson/assure-rust-crate/) //! //! //! # Introduction //! //! This Rust crate provides macros for Rust runtime checking, //! and each macro comes in three flavors: //! //! * `assert…!` returns `()` or calls [`panic!`] //! //! * `assume…!` returns [`Result`] with `Ok(true)` or `Err(…)` //! //! * `assure…!` returns [`Result`] with `Ok(true)` or `Ok(false)` or `Err(…)` //! //! Examples of `assert_lt!`: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! assert_lt!(1, 2); //! //-> () //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! // assert_lt!(2, 1); //! //-> panic!("assertion failed: `(left == right)`\n left: `2`,\n right: `1`") //! # } //! ``` //! //! Examples of `assume_lt!`: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_lt!(1, 2); //! //-> Ok(true) //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_lt!(2, 1); //! //-> Err("assumption failed: `(left == right)`\n left: `2`,\n right: `1`") //! # } //! ``` //! //! Examples of `assure_lt!`: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assure_lt!(1, 2); //! //-> Ok(true) //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assure_lt!(2, 1); //! //-> Ok(false) //! # } //! ``` //! //! # Assert //! //! The `assert…` macros can be useful with Rust testing, //! such as with macros that Rust `std` does not provide. //! //! Example: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! fn sum_positive_numbers(a: i32, b: i32) -> Result<i32, String> { //! assert_lt!(0, a); //! assert_lt!(0, b); //! Ok(a + b) //! } //! //! sum_positive_numbers(1, 2); //! //-> 3 //! //! // sum_positive_numbers(-1, -2); //! //-> panic!("assertion failed: `(left == right)`\n left: `0`,\n right: `-1`") //! # } //! ``` //! //! # Assume //! //! The `assume…` macros can be useful with the `?` operator, //! such as with early exits in functions. //! //! Example: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! fn sum_positive_numbers(a: i32, b: i32) -> Result<i32, String> { //! assume_lt!(0, a)?; //! assume_lt!(0, b)?; //! Ok(a + b) //! } //! //! sum_positive_numbers(1, 2); //! //-> Ok(3) //! //! sum_positive_numbers(-1, -2); //! //-> Err("assumption failed: `assume_lt(left, right)`\n left: `0`,\n right: `-1`") //! # } //! ``` //! //! //! # Assure //! //! The `assure…` macros can be useful with chaining, //! such as with gate conditions in functions. //! //! Example: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! fn sum_positive_numbers(a: i32, b: i32) -> Result<i32, String> { //! if assure_lt!(0, a).unwrap() && assure_lt!(0, b).unwrap() { //! Ok(a + b) //! } else { //! Err(format!("please use positive numbers")) //! } //! } //! //! sum_positive_numbers(1, 2); //! //-> Ok(3) //! //! sum_positive_numbers(-1, -2); //! //-> Err("must use postive numbers") //! # } //! ``` //! //! //! # Messages //! //! When a macro fails, it generates a failure message with the //! values of expressions with their debug representations, such as: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! // assert_lt!(2, 1) //! //-> panic!("assertion failed: `(left == right)`\n left: `2`,\n right: `1`") //! # } //! ``` //! //! These macros have a second form where a custom message can be provided, //! such as: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! // assert_lt!(2, 1, "my message here"); //! //-> panic!("my message here") //! # } //! ``` //! //! //! # Macros for values //! //! Examples: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_lt!(1, 2); //! //-> Ok(true) //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_lt!(2, 1); //! //-> Err("assumption failed: `assert_lt(left, right)`\n left: `2`\n right: `1`") //! # } //! ``` //! //! `assert…` macros: //! //! * [`assert!`]`(a)`: assure `a` is true, provided by Rust `std`. //! //! * [`assert_eq!`]`(a, b)`: assert `a` is equal to `b`, provided by Rust `std`. //! //! * [`assert_ne!`]`(a, b)`: assert `a` is not equal to `b`, provided by Rust `std`. //! //! * [`assert_lt!`]`(a, b)`: assert `a` is less than `b`. //! //! * [`assert_le!`]`(a, b)`: assert `a` is less than or equal to `b`. //! //! * [`assert_gt!`]`(a, b)`: assert `a` is greater than `b`. //! //! * [`assert_ge!`]`(a, b)`: assert `a` is greater than or equal to `b`. //! //! `assume…` macros: //! //! * [`assume!`]`(a)`: assume `a` is true. //! //! * [`assume_eq!`]`(a, b)`: assume `a` is equal to `b`. //! //! * [`assume_ne!`]`(a, b)`: assume `a` is not equal to `b`. //! //! * [`assume_lt!`]`(a, b)`: assume `a` is less than `b`. //! //! * [`assume_le!`]`(a, b)`: assume `a` is less than or equal to `b`. //! //! * [`assume_gt!`]`(a, b)`: assume `a` is greater than `b`. //! //! * [`assume_ge!`]`(a, b)`: assume `a` is greater than or equal to `b`. //! //! `assure…` macros: //! //! * [`assure!`]`(a)`: assure `a` is true. //! //! * [`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 //! //! These 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. //! //! Examples: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_set_eq!([1, 2], [2, 1]); //! //-> Ok(true) //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_set_eq!([1, 2], [3, 4]); //! //-> Err("assertion failed: `assert_set_eq(left, right)`\n left: `[1, 2]`\n right: `[3, 4]`") //! # } //! ``` //! //! `assert_set…` macros: //! //! * [`assert_set_eq!`]`(a, b)`: assert the set `a` is equal to the set `b`. //! //! * [`assert_set_ne!`]`(a, b)`: assert the set `a` is not equal to the set `b`. //! //! `assume_set…` macros: //! //! * [`assume_set_eq!`]`(a, b)`: assume the set `a` is equal to the set `b`. //! //! * [`assume_set_ne!`]`(a, b)`: assume the set `a` is not equal to the set `b`. //! //! `assure_set…` macros: //! //! * [`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`. //! //! //! # Macros for bag checking //! //! Thes 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. //! //! Examples: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_bag_eq!([1, 1], [1, 1]); //! //-> Ok(true) //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_bag_eq!([1, 1], [1, 1, 1]); //! //-> Err("assumption failed: `assume_bag_eq(left, right)`\n left: `[1, 1]`\n right: `[1, 1, 1]`")] //! # } //! ``` //! //! `assert_bag…` macros: //! //! * [`assert_bag_eq`]`(a, b)`: assert the bag `a` is equal to the bag `b`. //! //! * [`assert_bag_ne`]`(a, b)`: assert the bag `a` is not equal to the bag `b`. //! //! `assume_bag…` macros: //! //! * [`assume_bag_eq!`]`(a, b)`: assume the bag `a` is equal to the bag `b`. //! //! * [`assume_bag_ne!`]`(a, b)`: assume the bag `a` is not equal to the bag `b`. //! //! `assure_bag…` macros: //! //! * [`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`. //! //! //! # Macros for IO-related checking //! //! These 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))`. //! //! Examples: //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_io_lt!(1, 2); //! //-> Ok(true) //! # } //! ``` //! //! ```rust //! # #[macro_use] extern crate assertable; fn main() { //! let x = assume_io_lt!(2, 1); //! //-> Err( //! // std::io::Error::new( //! // std::io::ErrorKind::InvalidInput, //! // "assumption failed: `assume_io_lt(left, right)`\n left: `2`\n right: `1`")] //! // ) //! // ) //! # } //! ``` //! //! `assert_io…` macros: //! //! * [`assert_io!`]`(a)`: assert `a` is true. //! //! * [`assert_io_eq!`]`(a, b)`: assert `a` is equal to `b`. //! //! * [`assert_io_ne!`]`(a, b)`: assert `a` is not equal to `b`. //! //! * [`assert_io_lt!`]`(a, b)`: assert `a` is less than `b`. //! //! * [`assert_io_le!`]`(a, b)`: assert `a` is less than or equal to `b`. //! //! * [`assert_io_gt!`]`(a, b)`: assert `a` is greater than `b`. //! //! * [`assert_io_ge!`]`(a, b)`: assert `a` is greater than or equal to `b`. //! //! `assume_io…` macros: //! //! * [`assume_io!`]`(a)`: assume `a` is true. //! //! * [`assume_io_eq!`]`(a, b)`: assume `a` is equal to `b`. //! //! * [`assume_io_ne!`]`(a, b)`: assume `a` is not equal to `b`. //! //! * [`assume_io_lt!`]`(a, b)`: assume `a` is less than `b`. //! //! * [`assume_io_le!`]`(a, b)`: assume `a` is less than or equal to `b`. //! //! * [`assume_io_gt!`]`(a, b)`: assume `a` is greater than `b`. //! //! * [`assume_io_ge!`]`(a, b)`: assume `a` is greater than or equal to `b`. //! //! `assure_io…` macros: //! //! * [`assure_io!`]`(a)`: assure `a` is true. //! //! * [`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`. // Assert truth pub mod assert; // condition (provided by Rust `std`) // Assert value comparison pub mod assert_eq; // equal (provided by Rust `std`) pub mod assert_ne; // not equal (provided by Rust `std`) pub mod assert_lt; // less than pub mod assert_le; // less than or equal to pub mod assert_gt; // greater than pub mod assert_ge; // greater than or equal to // Assert iterator-related set-based comparison pub mod assert_set_eq; // equal pub mod assert_set_ne; // not equal // Assert iterator-related bag-based comparison pub mod assert_bag_eq; // equal pub mod assert_bag_ne; // not equal // Assert IO-related truth, which can return Err(std:io:Error(…)) //pub mod assert_io; // Assert IO-related comparison, which can return Err(std:io:Error(…)) pub mod assert_io_eq; // equal pub mod assert_io_ne; // not equal pub mod assert_io_lt; // less than pub mod assert_io_le; // less than or equal to pub mod assert_io_gt; // greater than pub mod assert_io_ge; // greater than or equal to // Assume truth pub mod assume; // condition // Assume value comparison pub mod assume_eq; // equal pub mod assume_ne; // not equal pub mod assume_lt; // less than pub mod assume_le; // less than or equal to pub mod assume_gt; // greater than pub mod assume_ge; // greater than or equal to // Assume iterator-related set-based comparison pub mod assume_set_eq; // equal pub mod assume_set_ne; // not equal // Assume iterator-related bag-based comparison pub mod assume_bag_eq; // equal pub mod assume_bag_ne; // not equal // Assume IO-related truth, which can return Err(std:io:Error(…)) pub mod assume_io; // Assume IO-related comparison, which can return Err(std:io:Error(…)) pub mod assume_io_eq; // equal pub mod assume_io_ne; // not equal pub mod assume_io_lt; // less than pub mod assume_io_le; // less than or equal to pub mod assume_io_gt; // greater than pub mod assume_io_ge; // greater than or equal to // Assure truth pub mod assure; // condition // 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