Enum Dir 

pub enum Dir {
    N = 0,
    NE = 1,
    E = 2,
    SE = 3,
    S = 4,
    SW = 5,
    W = 6,
    NW = 7,
}

Direction type.

This type represents a relative movement of one square.

It’s a building block for paths, iterating on a super::Pos neighbors, etc. It effectively represents the edges in a graph, while the Pos type represents nodes.

Variants

N = 0

North, or up

NE = 1

Northeast

E = 2

East, or right

SE = 3

Southeast

S = 4

South, or down

SW = 5

Southwest

W = 6

West, or left

NW = 7

Norwest

Implementations

impl Dir

pub const SIZE: usize = 8usize

Number of possible directions

pub const ALL8: [Self; 8]

All 8 possible values in enum order

Used to convert a usize into a Dir value via indexing.

pub const ALL4: [Self; 4]

The 4 “major” cardinal directions.

pub const NAMES_CARDINAL: [&'static str; 8]

The “cardinal” names of all corresponding Dir values.

Used to convert a Dir value into a &’static str via indexing.

pub const NAMES_UTF8: [&'static str; 8]

The UTF-8 symbol corresponding to Dir values.

Used to convert a Dir value into a &’static str via indexing.

pub const NAMES_UTF8_CHAR: [char; 8]

The UTF-8 symbol corresponding to Dir values.

Used to convert a Dir value into a char via indexing.

pub const NAMES_ASCII: [&'static str; 8]

The ASCII symbol corresponding to Dir values.

Used to convert a Dir value into a &’static str via indexing.

pub const NAMES_ASCII_CHAR: [char; 8]

The ASCII symbol corresponding to Dir values.

Used to convert a Dir value into a char via indexing.

pub const fn is_diagonal(&self) -> bool

Return true if the Dir is one of the diagonals: NE, SE, SW or NW.

pub const fn name_cardinal(&self) -> &'static str

Return the “cardinal” name of the Dir

pub const fn name_utf8(&self) -> &'static str

Return the UTF-8 arrow corresponding to the Dir

pub const fn name_utf8_char(&self) -> char

Return the UTF-8 arrow corresponding to the Dir

pub const fn name_ascii(&self) -> &'static str

Return the UTF-8 arrow corresponding to the Dir

pub const fn name_ascii_char(&self) -> char

Return the UTF-8 arrow corresponding to the Dir

pub const fn flip(&self) -> Dir

Flip the direction: N -> S, E -> W, etc.

pub const fn rotate(&self, other: &Dir) -> Dir

Rotate a Dir using the angle given by the other Dir argument

pub const fn next<const D: bool>(&self) -> Option<Self>

Return the next Dir in clockwise order, or None if self is the last one.

This function takes a generic const argument D that indicates if diagonals should be considered or not. If considered, the last Dir is Dir::NW, otherwise it’s Dir::S.

pub fn iter<const D: bool>() -> DirIter<D>

Returns an iterator that returns all possible values for the Dir type used, in clockwise order.

This function takes a generic const argument D that indicates if diagonals should be in the iteration or not.

Trait Implementations

impl<T: BoundedInt, U: BoundedInt> Add<Dir> for &(T, U)

type Output = Result<(T, U), Error>

The resulting type after applying the + operator.

fn add(self, rhs: Dir) -> Self::Output

Performs the + operation.

impl<const XMAX: u16, const YMAX: u16> Add<Dir> for &Pos<XMAX, YMAX>

where (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>): Add<Dir, Output = Result<(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>), Error>>,

type Output = Result<Pos<XMAX, YMAX>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Dir) -> Self::Output

Performs the + operation.

impl<T: BoundedInt, U: BoundedInt> Add<Dir> for (T, U)

type Output = Result<(T, U), Error>

The resulting type after applying the + operator.

fn add(self, rhs: Dir) -> Self::Output

Performs the + operation.

impl<const XMAX: u16, const YMAX: u16> Add<Dir> for Pos<XMAX, YMAX>

where (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>): Add<Dir, Output = Result<(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>), Error>>,

type Output = Result<Pos<XMAX, YMAX>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Dir) -> Self::Output

Performs the + operation.

impl Add for Dir

type Output = Dir

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Dir

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Dir

fn clone(&self) -> Dir

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Dir

fn default() -> Dir

Returns the “default value” for a type.

impl Display for Dir

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

Formats the value using the given formatter.

impl From<Dir> for (i128, i128)

fn from(dir: Dir) -> Self

Converts to this type from the input type.

impl From<Dir> for (i16, i16)

fn from(dir: Dir) -> Self

Converts to this type from the input type.

impl From<Dir> for (i32, i32)

fn from(dir: Dir) -> Self

Converts to this type from the input type.

impl From<Dir> for (i64, i64)

fn from(dir: Dir) -> Self

Converts to this type from the input type.

impl From<Dir> for (i8, i8)

fn from(dir: Dir) -> Self

Converts to this type from the input type.

impl From<Dir> for (isize, isize)

fn from(dir: Dir) -> Self

Converts to this type from the input type.

impl FromStr for Dir

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Dir

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 Neg for Dir

type Output = Dir

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Dir

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

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

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(i128, i128)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&(i16, i16)> for Dir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(i16, i16)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&(i32, i32)> for Dir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(i32, i32)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&(i64, i64)> for Dir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(i64, i64)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&(i8, i8)> for Dir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(i8, i8)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&(isize, isize)> for Dir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(isize, isize)) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<(T, T)> for Dir

where Dir: for<'a> TryFrom<&'a (T, T), Error = Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: (T, T)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<char> for Dir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(c: char) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Dir

impl Eq for Dir

impl StructuralPartialEq for Dir