Struct Assertion

pub struct Assertion<I, F: Fn(I) -> bool = fn(I) -> bool, M: Display = &'static str> { /* private fields */ }

An assert function with a message for runtime assertions.

Example

let asserter = Assertion::new("lhs is not equal to rhs.", |(lhs, rhs)| lhs == rhs);
asserter.assert((4, 4));
// Will panic here.
asserter.assert((4, 5));
 
asserter.debug_assert((4, 4));
// Will panic here in dev.
asserter.debug_assert((4, 5));

Implementations

impl<I, F: Fn(I) -> bool, M: Display> Assertion<I, F, M>

pub const fn new(message: M, function: F) -> Self

Create a new Assertion with the provided message that calls the provided function.

pub fn assert(&self, input: I)

Assert the function with the given input.

pub fn assert_with<Msg: Display>(&self, input: I, msg: Msg)

Assert the function with the given input, displaying the given msg if the assertion fails.

pub fn debug_assert(&self, input: I)

Assert the function with the given input in dev.

pub fn debug_assert_with<Msg: Display>(&self, input: I, msg: Msg)

Assert the function with the given input in dev, displaying the given msg if the assertion fails.