Enum VerticalDirection 

pub enum VerticalDirection {
    Either,
    Above,
    Below,
}

Where the counterpart of a ProximityProjection::Vertical distance must lie relative to the subject.

Compare the two vertical extents (bottom to top) end by end. A counterpart lies above the subject unless it lies lower at both ends (its top below the subject’s top and its bottom below the subject’s bottom), and below unless it lies higher at both ends. A counterpart overlapping the subject in height is therefore above, below or both at distance zero: a pendant reaching down past a sprinkler’s top is above it, a riser passing the sprinkler is both. Every counterpart is above or below, so the Either distance is the lesser of the two.

Variants

Either

Above or below: the gap between the two extents.

Above

The counterpart lies above: the gap from the subject’s top up to the counterpart’s bottom, zero when the extents overlap.

Below

The counterpart lies below: the gap from the subject’s bottom down to the counterpart’s top, zero when the extents overlap.

Implementations

impl VerticalDirection

pub fn name(self) -> &'static str

The direction’s spelling in rule parameters, evidence and messages.

Trait Implementations

impl Clone for VerticalDirection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VerticalDirection

impl Debug for VerticalDirection

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

Formats the value using the given formatter.

impl Eq for VerticalDirection

impl Hash for VerticalDirection

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 VerticalDirection

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for VerticalDirection

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VerticalDirection

fn partial_cmp(&self, other: &Self) -> 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 VerticalDirection