Enum substrate::geometry::prelude::Side

#[repr(u8)]
pub enum Side {
    Left = 0,
    Bot = 1,
    Right = 2,
    Top = 3,
}

An enumeration of the sides of an axis-aligned rectangle.

Variants

Left = 0

The left side.

Bot = 1

The bottom side.

Right = 2

The right side.

Top = 3

The top side.

Implementations

impl Side

pub const fn iter() -> SideIndexableIter

Returns an iterator over all items of Side

pub const fn count() -> usize

Returns the number of items that will be returned by SideIndexableIter that are not disabled members of Side

impl Side

pub fn coord_dir(&self) -> Dir

Gets the direction of the coordinate corresponding to this side.

Top and bottom edges are y-coordinates, so they are on the vertical axis. Left and right edges are x-coordinates, so they are on the horizontal axis.

Also see Side::edge_dir.

pub fn edge_dir(&self) -> Dir

Gets the direction of the edge corresponding to this side.

Top and bottom edges are horizontal line segments; left and right edges are vertical line segments.

Also see Side::coord_dir.

pub fn other(&self) -> Side

Returns the opposite direction.

pub fn sign(&self) -> Sign

Returns the sign corresponding to moving towards this side.

pub fn with_dir_and_sign(dir: Dir, sign: Sign) -> Side

Returns the side corresponding with the given Dir and Sign.

Example

assert_eq!(Side::with_dir_and_sign(Dir::Horiz, Sign::Neg), Side::Left);
assert_eq!(Side::with_dir_and_sign(Dir::Vert, Sign::Neg), Side::Bot);
assert_eq!(Side::with_dir_and_sign(Dir::Horiz, Sign::Pos), Side::Right);
assert_eq!(Side::with_dir_and_sign(Dir::Vert, Sign::Pos), Side::Top);

pub fn with_dir(dir: Dir) -> [Side; 2]

Returns sides that bound the given direction.

Users should not rely upon the order of the sides returned.

Example

assert_eq!(Side::with_dir(Dir::Horiz), [Side::Left, Side::Right]);
assert_eq!(Side::with_dir(Dir::Vert), [Side::Bot, Side::Top]);

Trait Implementations

impl Clone for Side

fn clone(&self) -> Side

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Side

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Side

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Side

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<T> Index<Side> for Sides<T>

type Output = T

The returned type after indexing.

fn index(&self, index: Side) -> &<Sides<T> as Index<Side>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Side> for Sides<T>

fn index_mut(&mut self, index: Side) -> &mut <Sides<T> as Index<Side>>::Output

Performs the mutable indexing (container[index]) operation.

impl Indexable for Side

const SIZE: usize = 4usize

The number of items or variants that this type can have.

const SET_SIZE: usize = 1usize

The number of bytes it will take to represent this type in a set.

type Iter = SideIndexableIter

The type of Iterator that will be returned by [Self::iter()]

fn index(self) -> usize

Maps self to usize to know which value in the underling array to use

fn iter() -> <Side as Indexable>::Iter

An Iterator over all valid values of self

impl Not for Side

fn not(self) -> <Side as Not>::Output

Exclamation Operator returns the opposite direction

type Output = Side

The resulting type after applying the ! operator.

impl PartialEq for Side

fn eq(&self, other: &Side) -> 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 ReverseIndexable for Side

fn from_index(u: usize) -> Side

Converts from a usize to Self

impl Serialize for Side

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 Side

impl Eq for Side

impl StructuralPartialEq for Side