Enum proptest::prelude::TestCaseError

pub enum TestCaseError {
    Reject(Reason),
    Fail(Reason),
}

Errors which can be returned from test cases to indicate non-successful completion.

Note that in spite of the name, TestCaseError is currently not an instance of Error, since otherwise impl<E : Error> From<E> could not be provided.

Any Error can be converted to a TestCaseError, which places Error::display() into the Fail case.

Variants

Reject(Reason)

The input was not valid for the test case. This does not count as a test failure (nor a success); rather, it simply signals to generate a new input and try again.

Fail(Reason)

The code under test failed the test.

Implementations

impl TestCaseError

pub fn reject(reason: impl Into<Reason>) -> Self

Rejects the generated test input as invalid for this test case. This does not count as a test failure (nor a success); rather, it simply signals to generate a new input and try again.

The string gives the location and context of the rejection, and should be suitable for formatting like Foo did X at {whence}.

pub fn fail(reason: impl Into<Reason>) -> Self

The code under test failed the test.

The string should indicate the location of the failure, but may generally be any string.

Trait Implementations

impl Clone for TestCaseError

fn clone(&self) -> TestCaseError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TestCaseError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TestCaseError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: Error> From<E> for TestCaseError

fn from(cause: E) -> Self

Converts to this type from the input type.