#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

#2712 in Rust patterns

Download history 19/week @ 2024-01-04 31/week @ 2024-01-11 46/week @ 2024-01-18 81/week @ 2024-01-25 89/week @ 2024-02-01 64/week @ 2024-02-08 82/week @ 2024-02-15 105/week @ 2024-02-22 151/week @ 2024-02-29 215/week @ 2024-03-07 118/week @ 2024-03-14 114/week @ 2024-03-21 91/week @ 2024-03-28 160/week @ 2024-04-04 91/week @ 2024-04-11 113/week @ 2024-04-18

463 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