Enum CardinalDirection 

#[repr(u8)]
pub enum CardinalDirection {
    North = 0,
    East = 1,
    South = 2,
    West = 3,
}

Variants

North = 0

East = 1

South = 2

West = 3

Implementations

impl CardinalDirection

pub fn from_unit_coord(coord: ICoord) -> Self

pub fn direction(self) -> Direction

pub fn opposite(self) -> CardinalDirection

pub fn coord(self) -> ICoord

pub fn left90(self) -> CardinalDirection

pub fn right90(self) -> CardinalDirection

pub fn left45(self) -> OrdinalDirection

pub fn right45(self) -> OrdinalDirection

pub fn left135(self) -> OrdinalDirection

pub fn right135(self) -> OrdinalDirection

pub fn axis(self) -> Axis

pub fn sign(self) -> i32

pub fn axis_and_sign(self) -> (Axis, i32)

pub const fn all() -> CardinalDirectionIter

pub const fn all_directions() -> DirectionCardinalIter

pub fn combine(self, other: Self) -> Option<OrdinalDirection>

Trait Implementations

impl Clone for CardinalDirection

fn clone(&self) -> CardinalDirection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CardinalDirection

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

Formats the value using the given formatter.

impl From<CardinalDirection> for [i32; 2]

fn from(c: CardinalDirection) -> [i32; 2]

Converts to this type from the input type.

impl From<CardinalDirection> for (i32, i32)

fn from(c: CardinalDirection) -> (i32, i32)

Converts to this type from the input type.

impl From<CardinalDirection> for Direction

fn from(c: CardinalDirection) -> Self

Converts to this type from the input type.

impl Hash for CardinalDirection

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<T> Index<CardinalDirection> for CardinalDirectionTable<T>

type Output = T

The returned type after indexing.

fn index(&self, index: CardinalDirection) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<CardinalDirection> for CardinalDirectionTable<T>

fn index_mut(&mut self, index: CardinalDirection) -> &mut Self::Output

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

impl Ord for CardinalDirection

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

impl PartialEq for CardinalDirection

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CardinalDirection

fn partial_cmp(&self, other: &CardinalDirection) -> 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 Copy for CardinalDirection

impl Eq for CardinalDirection

impl StructuralPartialEq for CardinalDirection