Enum gardiz::direc::Direction

pub enum Direction {
    Up,
    Down,
    Left,
    Right,
}

Basic direction in a plane.

Variants

Up

Direction up (towards negative Y).

Down

Direction down (towards positive Y).

Left

Direction left (towards negative X).

Right

Direction right (towards positive X).

Implementations

impl Direction

pub const ALL: [Direction; 4] = _

List of all possible directions. Please note that this requires no heap-allocation and is very cheap.

pub fn iter() -> Iter

Iterator over all directions.

Examples

Note that these examples put the directions in a vector, but if you want an array of directions, just use Direction::ALL.

Default Order

use gardiz::direc::{self, Direction};

let direcs: Vec<Direction> = Direction::iter().collect();
assert_eq!(
    vec![Direction::Up, Direction::Down, Direction::Left, Direction::Right],
    direcs
);

Reverse Order

use gardiz::direc::{self, Direction};

let direcs: Vec<Direction> = Direction::iter().rev().collect();
assert_eq!(
    vec![Direction::Right, Direction::Left, Direction::Down, Direction::Up],
    direcs
);

pub fn from_axis_pos(axis: Axis) -> Self

Creates a direction from the given axis in the positive direction (i.e. X -> Right and Y -> Down).

pub fn from_axis_neg(axis: Axis) -> Self

Creates a direction from the given axis in the negative direction (i.e. X -> Left and Y -> Up).

pub fn axis(self) -> Axis

Axis on which the direciton varies.

pub fn rotate_clockwise(self) -> Self

Rotates the direction clockwise.

pub fn rotate_countercw(self) -> Self

Rotates the direction counter-clockwise.

Trait Implementations

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 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 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<T> Index<Direction> for DirecMap<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 DirecMap<T>

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

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

impl Not for Direction

type Output = Direction

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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 ==.

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

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

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.

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

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

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

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

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

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

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 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 StructuralEq for Direction

impl StructuralPartialEq for Direction