#testing #macro #utility

assert_ok

A macro that asserts a Result is Ok

3 stable releases

1.0.2 Nov 17, 2022
1.0.1 Mar 17, 2022

#2689 in Rust patterns

Download history 207/week @ 2023-12-13 114/week @ 2023-12-20 27/week @ 2023-12-27 24/week @ 2024-01-03 32/week @ 2024-01-10 38/week @ 2024-01-17 80/week @ 2024-01-24 84/week @ 2024-01-31 62/week @ 2024-02-07 82/week @ 2024-02-14 98/week @ 2024-02-21 91/week @ 2024-02-28 264/week @ 2024-03-06 133/week @ 2024-03-13 126/week @ 2024-03-20 64/week @ 2024-03-27

600 downloads per month

Apache-2.0 OR MIT

3KB

assert_ok

crates.io docs.rs

This crate contains a macro assert_ok which takes an expression and if the expression evaluates to an Err, panics with a useful message. If in contrast the expression evaluates to Ok(v) then it returns the value v.

This is commonly useful in tests. Instead of

let z = foo(arg1, arg2).unwrap();

or

let z = foo(arg1, arg2).expect("foo failed");

use

let z = assert_ok!(foo(arg1, arg2));

It's easier to understand (IMO) and more importantly provides a much more useful error message in the case that it fails.

There is a similar macro in Tokio, however for libraries or applications that don't use Tokio, pulling it in for a single macro doesn't make sense.


lib.rs:

A macro that asserts that a Result is [Ok]

No runtime deps