Enum Assertion 

pub enum Assertion {
    Any,
    IsType(TAtomic),
    IsNotType(TAtomic),
    Falsy,
    Truthy,
    IsIdentical(TAtomic),
    IsNotIdentical(TAtomic),
    IsEqual(TAtomic),
    IsNotEqual(TAtomic),
    IsEqualIsset,
    IsIsset,
    IsNotIsset,
    HasStringArrayAccess,
    HasIntOrStringArrayAccess,
    ArrayKeyExists,
    ArrayKeyDoesNotExist,
    InArray(TUnion),
    NotInArray(TUnion),
    HasArrayKey(ArrayKey),
    DoesNotHaveArrayKey(ArrayKey),
    HasNonnullEntryForKey(ArrayKey),
    DoesNotHaveNonnullEntryForKey(ArrayKey),
    Empty,
    NonEmpty,
    NonEmptyCountable(bool),
    EmptyCountable,
    HasExactCount(usize),
    HasAtLeastCount(usize),
    DoesNotHaveExactCount(usize),
    DoesNotHasAtLeastCount(usize),
    IsLessThan(i64),
    IsLessThanOrEqual(i64),
    IsGreaterThan(i64),
    IsGreaterThanOrEqual(i64),
    IsLessThanFromBound(i64),
    IsLessThanOrEqualFromBound(i64),
    IsGreaterThanFromBound(i64),
    IsGreaterThanOrEqualFromBound(i64),
    IsLessThanVariable(Word),
    IsLessThanOrEqualVariable(Word),
    IsGreaterThanVariable(Word),
    IsGreaterThanOrEqualVariable(Word),
    Countable,
    NotCountable(bool),
}

Variants

Any

IsType(TAtomic)

IsNotType(TAtomic)

Falsy

Truthy

IsIdentical(TAtomic)

IsNotIdentical(TAtomic)

IsEqual(TAtomic)

IsNotEqual(TAtomic)

IsEqualIsset

IsIsset

IsNotIsset

HasStringArrayAccess

HasIntOrStringArrayAccess

ArrayKeyExists

ArrayKeyDoesNotExist

InArray(TUnion)

NotInArray(TUnion)

HasArrayKey(ArrayKey)

DoesNotHaveArrayKey(ArrayKey)

HasNonnullEntryForKey(ArrayKey)

DoesNotHaveNonnullEntryForKey(ArrayKey)

Empty

NonEmpty

NonEmptyCountable(bool)

EmptyCountable

HasExactCount(usize)

HasAtLeastCount(usize)

DoesNotHaveExactCount(usize)

DoesNotHasAtLeastCount(usize)

IsLessThan(i64)

IsLessThanOrEqual(i64)

IsGreaterThan(i64)

IsGreaterThanOrEqual(i64)

IsLessThanFromBound(i64)

A range fact implied by a comparison with a non-literal bound.

For example, $a > $b with int<0, max> $b implies $a > 0 in the true branch, but its negation does not imply $a <= 0. These assertions therefore deliberately negate to Any.

IsLessThanOrEqualFromBound(i64)

IsGreaterThanFromBound(i64)

IsGreaterThanOrEqualFromBound(i64)

IsLessThanVariable(Word)

An exact comparison with another tracked expression.

Unlike bound-derived facts, these retain the relationship so consumers can reason about arithmetic such as $limit - $length after $length < $limit.

IsLessThanOrEqualVariable(Word)

IsGreaterThanVariable(Word)

IsGreaterThanOrEqualVariable(Word)

Countable

NotCountable(bool)

Implementations

impl Assertion

pub fn to_atom(&self) -> Word

pub fn to_hash(&self) -> u64

pub fn is_negation(&self) -> bool

pub fn has_isset(&self) -> bool

pub fn has_equality(&self) -> bool

pub fn has_literal_value(&self) -> bool

pub fn with_type(&self, atomic: TAtomic) -> Self

pub fn get_type(&self) -> Option<&TAtomic>

pub fn get_type_mut(&mut self) -> Option<&mut TAtomic>

pub fn resolve_templates( &self, codebase: &CodebaseMetadata, template_result: &TemplateResult, ) -> Vec<Self>

pub fn is_negation_of(&self, other: &Assertion) -> bool

pub fn get_negation(&self) -> Self

pub const fn is_negatable(&self) -> bool

Whether this assertion represents the condition itself and can be used while constructing the opposite branch.

Facts inferred from a non-literal range bound are only consequences of a condition. They are useful in the true branch but are not logically equivalent to that condition, so negating them would be unsound.

pub const fn referenced_variable(&self) -> Option<Word>

Returns the expression referenced by a relational assertion.

Trait Implementations

impl Clone for Assertion

fn clone(&self) -> Assertion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Assertion

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

Formats the value using the given formatter.

impl Eq for Assertion

impl Hash for Assertion

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 Assertion

fn cmp(&self, other: &Assertion) -> 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 Assertion

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Assertion

fn partial_cmp(&self, other: &Assertion) -> 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 StructuralPartialEq for Assertion