Enum iron_shapes::types::ContainsResult

pub enum ContainsResult {
    No,
    OnBounds,
    WithinBounds,
}

This is a result type for containment checks.

• No Not inside.
• OnBounds Lies on the boundaries.
• WithinBounds Fully inside.

Variants

No

Does not contain the point.

OnBounds

Contains the point but on the borders/end-points.

WithinBounds

Fully contains the point.

Implementations

impl ContainsResult

pub fn is_within_bounds(&self) -> bool

Tells if the point is contained but does not lie on the bounds.

pub fn inclusive_bounds(&self) -> bool

Tells if the point is contained or lies on the bounds.

pub fn on_bounds(&self) -> bool

Check if the point neither is on the bounds nor within the bounds.

pub fn is_no(&self) -> bool

Check if the point lies on the bounds.

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

Returns the stronger result of the both. Ordering from weak to strong is No, OnBounds, WithinBounds

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

Returns the weaker result of the both. Ordering from weak to strong is No, OnBounds, WithinBounds

Trait Implementations

impl Clone for ContainsResult

fn clone(&self) -> ContainsResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainsResult

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

Formats the value using the given formatter.

impl PartialEq<ContainsResult> for ContainsResult

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for ContainsResult

impl Eq for ContainsResult

impl StructuralEq for ContainsResult

impl StructuralPartialEq for ContainsResult