summaryrefslogtreecommitdiffstats
path: root/vendor/always-assert/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/always-assert/README.md
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/always-assert/README.md')
-rw-r--r--vendor/always-assert/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/vendor/always-assert/README.md b/vendor/always-assert/README.md
new file mode 100644
index 000000000..7494139a1
--- /dev/null
+++ b/vendor/always-assert/README.md
@@ -0,0 +1,20 @@
+# always-assert
+
+Recoverable assertions, inspired by [the use of `assert()` in SQLite](https://www.sqlite.org/assert.html).
+
+```rust
+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(())
+}
+```