5 releases

0.2.0 Jan 23, 2024
0.1.3 Apr 7, 2023
0.1.2 Feb 4, 2021
0.1.1 Jan 26, 2021
0.1.0 Jan 26, 2021

#46 in Debugging

Download history 42839/week @ 2024-01-18 41435/week @ 2024-01-25 40695/week @ 2024-02-01 48583/week @ 2024-02-08 51815/week @ 2024-02-15 52203/week @ 2024-02-22 48813/week @ 2024-02-29 46258/week @ 2024-03-07 46981/week @ 2024-03-14 52002/week @ 2024-03-21 52085/week @ 2024-03-28 57419/week @ 2024-04-04 53882/week @ 2024-04-11 52820/week @ 2024-04-18 46068/week @ 2024-04-25 38742/week @ 2024-05-02

201,737 downloads per month
Used in 83 crates (6 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

~84KB