Enum substrate::geometry::prelude::Containment

pub enum Containment {
    None,
    Partial,
    Full,
}

Ways in which an inner shape can be contained within an enclosing shape.

Variants

None

The enclosing shape does not contain any part of the inner shape.

Partial

The shape is partially contained in the enclosing shape.

Full

The shape is fully contained in the enclosing shape.

Implementations

impl Containment

pub fn is_full(&self) -> bool

Returns true when fully contained.

pub fn intersects(&self) -> bool

Returns true if there is at least partial containment.

pub fn only_partially_intersects(&self) -> bool

Returns true if there is only partial containment.

pub fn is_none(&self) -> bool

Returns true if there is no containment.

Trait Implementations

impl Clone for Containment

fn clone(&self) -> Containment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Containment

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

Formats the value using the given formatter.

impl Default for Containment

fn default() -> Containment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Containment

fn deserialize<__D>( __deserializer: __D ) -> Result<Containment, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Containment

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

where __H: Hasher,

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 Containment

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

Restrict a value to a certain interval.

impl PartialEq for Containment

fn eq(&self, other: &Containment) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Containment

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Containment

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Containment

impl Eq for Containment

impl StructuralPartialEq for Containment