Enum direction::CardinalDirection

#[repr(u8)]
pub enum CardinalDirection {
    North,
    East,
    South,
    West,
}

Variants

NorthEastSouthWest

Methods

impl CardinalDirection

pub fn from_unit_coord(coord: Coord) -> Self

pub fn direction(self) -> Direction

pub fn opposite(self) -> CardinalDirection

pub fn coord(self) -> Coord

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)

Trait Implementations

impl Eq for CardinalDirection

impl Clone for CardinalDirection

fn clone(&self) -> CardinalDirection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CardinalDirection

impl PartialOrd<CardinalDirection> for CardinalDirection

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 PartialEq<CardinalDirection> for CardinalDirection

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

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

#[must_use]

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

This method tests for !=.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl From<CardinalDirection> for Direction

fn from(c: CardinalDirection) -> Self

Performs the conversion.

impl From<CardinalDirection> for [i32; 2]

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

Performs the conversion.

impl From<CardinalDirection> for (i32, i32)

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

Performs the conversion.

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, 

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 Debug for CardinalDirection

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

Formats the value using the given formatter.