claims

Macro assert_ready

Source
macro_rules! assert_ready {
    ($cond:expr $(,)?) => { ... };
    ($cond:expr, $($arg:tt)+) => { ... };
}
Expand description

Asserts that the expression matches a Poll::Ready(_) variant.

§Uses

Assertions are always checked in both debug and release builds, and cannot be disabled. See debug_assert_ready! for assertions that are not enabled in release builds by default.

§Custom messages

This macro has a second form, where a custom panic message can be provided with or without arguments for formatting. See std::fmt for syntax for this form.

§Examples

let res = Poll::Ready(42);

assert_ready!(res);

The contained value will also be returned from this macro call:

let res = Poll::Ready(42);

let value = assert_ready!(res);
assert_eq!(value, 42);

A Poll::Pending variant will panic:

let res = Poll::Pending;

assert_ready!(res);  // Will panic