#assert

always-assert

Recoverable assertions for long-running robust applications

3 releases

0.1.2 Feb 4, 2021
0.1.1 Jan 26, 2021
0.1.0 Jan 26, 2021

#146 in Debugging

Download history 16995/week @ 2022-06-09 16752/week @ 2022-06-16 13809/week @ 2022-06-23 15075/week @ 2022-06-30 14753/week @ 2022-07-07 14532/week @ 2022-07-14 14557/week @ 2022-07-21 17311/week @ 2022-07-28 18304/week @ 2022-08-04 18292/week @ 2022-08-11 17818/week @ 2022-08-18 18705/week @ 2022-08-25 21715/week @ 2022-09-01 18779/week @ 2022-09-08 19498/week @ 2022-09-15 16889/week @ 2022-09-22

80,543 downloads per month
Used in 47 crates (2 directly)

MIT/Apache

8KB

always-assert

Recoverable assertions, inspired by the use of assert() in SQLite.

use always_assert::never;

fn apply_transaction(&mut self, tx: Transaction) -> Result<(), TransactionAborted> {
    let delta = self.compute_delta(&tx);

    if never!(!self.check_internal_invariant(&delta)) {
        // Ok, something in this transaction messed up our internal state.
        // This really shouldn't be happening, and this signifies a bug.
        // Luckily, we can recover by just rejecting the transaction.
        return abort_transaction(tx);
    }
    self.commit(delta);
    Ok(())
}

lib.rs:

Recoverable assertions, inspired by the use of assert() in SQLite.

never! and always! return the actual value of the condition if debug_assertions are disabled.

Use them when terminating on assertion failure is worse than continuing.

One example would be a critical application like a database:

use always_assert::never;

fn apply_transaction(&mut self, tx: Transaction) -> Result<(), TransactionAborted> {
    let delta = self.compute_delta(&tx);

    if never!(!self.check_internal_invariant(&delta)) {
        // Ok, something in this transaction messed up our internal state.
        // This really shouldn't be happening, and this signifies a bug.
        // Luckily, we can recover by just rejecting the transaction.
        return abort_transaction(tx);
    }
    self.commit(delta);
    Ok(())
}

Another example is assertions about non-critical functionality in usual apps

use always_assert::never;

let english_message = "super app installed!"
let mut local_message = localize(english_message);
if never!(local_message.is_empty(), "missing localization for {}", english_message) {
    // We localized all the messages but this one slipper through the cracks?
    // Better to show the english one then than to fail outright;
    local_message = english_message;
}
println!("{}", local_message);

Dependencies

~22KB