Enum substrate::geometry::dir::Dir

#[repr(u8)]
pub enum Dir {
    Horiz = 0,
    Vert = 1,
}

An enumeration of axis-aligned directions.

Variants

Horiz = 0

The horizontal, or x-aligned, direction.

Vert = 1

The vertical, or y-aligned, direction.

Implementations

impl Dir

pub const fn iter() -> DirIndexableIter

Returns an iterator over all items of Dir

pub const fn count() -> usize

Returns the number of items that will be returned by DirIndexableIter that are not disabled members of Dir

impl Dir

pub const fn other(&self) -> Dir

Returns the other direction.

Example

assert_eq!(Dir::Vert.other(), Dir::Horiz);
assert_eq!(Dir::Horiz.other(), Dir::Vert);

Trait Implementations

impl Clone for Dir

fn clone(&self) -> Dir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dir

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dir

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

Displays the direction in a human-readable format.

Currently, Dir::Horiz becomes horizontal; Dir::Vert becomes vertical. However, users should not rely on these particular strings.

Example

assert_eq!(format!("{}", Dir::Horiz), "horizontal");
assert_eq!(format!("{}", Dir::Vert), "vertical");

impl Hash for Dir

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<Dir> for Dirs<T>

type Output = T

The returned type after indexing.

fn index(&self, index: Dir) -> &<Dirs<T> as Index<Dir>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Dir> for Dirs<T>

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

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

impl Indexable for Dir

const SIZE: usize = 2usize

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 = DirIndexableIter

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() -> <Dir as Indexable>::Iter

An Iterator over all valid values of self

impl Not for Dir

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

Returns the other direction.

Example

assert_eq!(!Dir::Vert, Dir::Horiz);
assert_eq!(!Dir::Horiz, Dir::Vert);

type Output = Dir

The resulting type after applying the ! operator.

impl PartialEq for Dir

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

fn from_index(u: usize) -> Dir

Converts from a usize to Self

impl Serialize for Dir

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 Dir

impl Eq for Dir

impl StructuralPartialEq for Dir