Enum direction::Direction

#[repr(u8)]
pub enum Direction {
    North,
    NorthEast,
    East,
    SouthEast,
    South,
    SouthWest,
    West,
    NorthWest,
}

Variants

NorthNorthEastEastSouthEastSouthSouthWestWestNorthWest

Methods

impl Direction

pub fn from_unit_coord(coord: Coord) -> Self

pub fn opposite(self) -> Direction

pub fn coord(self) -> Coord

pub fn left90(self) -> Direction

pub fn right90(self) -> Direction

pub fn left45(self) -> Direction

pub fn right45(self) -> Direction

pub fn left135(self) -> Direction

pub fn right135(self) -> Direction

pub fn bitmap_raw(self) -> u8

pub fn bitmap(self) -> DirectionBitmap

pub fn is_cardinal(self) -> bool

pub fn is_ordinal(self) -> bool

pub fn typ(self) -> DirectionType

pub fn cardinal(self) -> Option<CardinalDirection>

pub fn ordinal(self) -> Option<OrdinalDirection>

Trait Implementations

impl Eq for Direction

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Direction

impl PartialOrd<Direction> for Direction

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

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

fn cmp(&self, other: &Direction) -> 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<OrdinalDirection> for Direction

fn from(o: OrdinalDirection) -> Self

Performs the conversion.

impl From<Direction> for [i32; 2]

fn from(d: Direction) -> [i32; 2]

Performs the conversion.

impl From<Direction> for (i32, i32)

fn from(d: Direction) -> (i32, i32)

Performs the conversion.

impl Hash for Direction

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<Direction> for DirectionTable<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Direction> for DirectionTable<T>

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

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

impl Debug for Direction

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

Formats the value using the given formatter.