Enum gridly::direction::Direction

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

The four cardinal directions (up, down, left, right).

Variants

Up

The negative row direction

Down

The positive row direction

Left

The negative column direction

Right

The positive column direction

Methods

impl Direction

pub fn sized_vec(self, length: isize) -> Vector

Return a vector with the given length in this direction

pub fn unit_vec(self) -> Vector

Return the unit vector in the given direction

pub fn is_vertical(self) -> bool

True if this is Up or Down

pub fn is_horizontal(self) -> bool

True if this is Left or Right

pub fn reverse(self) -> Direction

Reverse this direction (Up -> Down, etc)

pub fn clockwise(self) -> Direction

Rotate this direction clockwise

pub fn counter_clockwise(self) -> Direction

Rotate this direction counterclockwise

Trait Implementations

impl Copy for Direction

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]

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

This method tests for !=.

impl Eq for Direction

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Direction> for Vector

Convert a Direction into a unit vector pointing in that direction

fn from(direction: Direction) -> Self

Performs the conversion.

impl Hash for Direction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Mul<isize> for Direction

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, amount: isize) -> Vector

Performs the * operation.

impl Neg for Direction

type Output = Direction

The resulting type after applying the - operator.

fn neg(self) -> Direction

Performs the unary - operation.

impl Debug for Direction

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

Formats the value using the given formatter.