Enum AssertionKind 

#[non_exhaustive]
pub enum AssertionKind {
    Always,
    AlwaysOrUnreachable,
    Sometimes,
    Reachable,
    Unreachable,
}

Which assertion macro a declaration came from.

This is the typed form of the display_type field in the serialized event; display_type() gives that string back. It is distinct from AssertType, the three-way wire-level enum, which cannot tell assert_always! from assert_always_or_unreachable! or assert_reachable! from assert_unreachable! without also consulting must_hit.

The numeric and boolean macros (assert_always_greater_than!, assert_sometimes_all!, and so on) are ordinary Always or Sometimes assertions with guidance attached, and report as such.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Always

assert_always!: the condition must hold on every evaluation, and the assertion must be reached.

AlwaysOrUnreachable

assert_always_or_unreachable!: the condition must hold on every evaluation, but the assertion need never be reached.

Sometimes

assert_sometimes!: the condition must hold on at least one evaluation.

Reachable

assert_reachable!: the assertion must be reached at least once.

Unreachable

assert_unreachable!: the assertion must never be reached.

Implementations

impl AssertionKind

pub const fn display_type(self) -> &'static str

The display_type string that serialized events carry for this kind, which is also how the triage report labels it. Use it to match catalog entries against events read back from a run.

Trait Implementations

impl Clone for AssertionKind

fn clone(&self) -> AssertionKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssertionKind

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

Formats the value using the given formatter.

impl Hash for AssertionKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AssertionKind

fn cmp(&self, other: &AssertionKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AssertionKind

fn eq(&self, other: &AssertionKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AssertionKind

fn partial_cmp(&self, other: &AssertionKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AssertionKind

impl Eq for AssertionKind

impl StructuralPartialEq for AssertionKind