Enum Direction

pub enum Direction {
    Right = 0,
    Down = 1,
    Left = 2,
    Up = 3,
}

Axis-aligned directions

This is a variable instantiation of Directional.

A default direction is provided, though somewhat arbitrary: Right.

Variants

Right = 0

Down = 1

Left = 2

Up = 3

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

fn default() -> Self

Returns the “default value” for a type.

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

type Flipped = Direction

Direction flipped over diagonal (i.e. Down ↔ Right)

type Reversed = Direction

Direction reversed along axis (i.e. Left ↔ Right)

fn flipped(self) -> Self::Flipped

Flip over diagonal (i.e. Down ↔ Right)

fn reversed(self) -> Self::Reversed

Reverse along axis (i.e. Left ↔ Right)

fn as_direction(self) -> Direction

Convert to the Direction enum

fn is_vertical(self) -> bool

Up or Down

fn is_horizontal(self) -> bool

Left or Right

fn is_reversed(self) -> bool

Left or Up

impl Display for Direction

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

Formats the value using the given formatter.

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