Enum Direction 

#[repr(u8)]
pub enum Direction {
    East = 0,
    NorthEast = 1,
    North = 2,
    NorthWest = 3,
    West = 4,
    SouthWest = 5,
    South = 6,
    SouthEast = 7,
}

An enumeration of compass directions. The traditional “cardinal” directions, along with the “ordinal” ones as well.

We use a counter-clockwise ordering starting at East, so that it aligns well with radian angles.

Variants

East = 0

NorthEast = 1

North = 2

NorthWest = 3

West = 4

SouthWest = 5

South = 6

SouthEast = 7

Implementations

impl Direction

pub const VALUES: &'static DirectionSet

A reference to the set of all possible Directions.

pub const CARDINAL: &'static DirectionSet

A reference to the set of cardinal Directions.

pub const ORDINAL: &'static DirectionSet

A reference to the set of ordinal Directions.

pub fn parse(s: &str) -> Option<Direction>

Parse a string into a Direction. Both long and full direction names are supported, along with whitespace, hyphens, and underscores between the intercardinal direction words.

pub fn short_name(self) -> &'static str

Obtain an abbreviated name for this Direction.

pub fn is_cardinal(self) -> bool

Is this a cardinal Direction?

pub fn is_ordinal(self) -> bool

Is this an ordinal Direction?

pub fn from_u8_checked(value: u8) -> Option<Direction>

Convert a u8 value to an Option<Direction>. Returns None if the provided value is not in the range 0-7.

pub fn from_u8(value: u8) -> Direction

Convert a u8 value to a Direction. Will panic if the value is not in the range 0-7.

pub fn clockwise(self) -> Direction

Produce the Direction clockwise from this Direction.

pub fn counter_clockwise(self) -> Direction

Produce the Direction counter-clockwise from this Direction.

pub fn rotate(self, steps: isize) -> Direction

Rotate this Direction by the given number of steps. Positivesteps rotate clockwise, negative steps rotate counter-clockwise.

pub fn opposite(self) -> Direction

The opposite Direction from this Direction.

pub fn angle(self) -> f32

The angle of this Direction in radians.

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Direction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Direction

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

Formats the value using the given formatter.

impl FromIterator<Direction> for DirectionSet

fn from_iter<I: IntoIterator<Item = Direction>>(iter: I) -> Self

Creates a value from an iterator.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for Direction

type Output = Direction

The resulting type after applying the ! operator.

fn not(self) -> Direction

Performs the unary ! operation.

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

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 Direction

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction