Enum Direction

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

Variants

Up

Left

Down

Right

Implementations

impl Direction

pub const ALL: [Self; 4]

pub fn new(axis: Axis, order: Order) -> Self

pub fn axis(self) -> Axis

pub fn order(self) -> Order

pub fn move_unit<C>(self, target: CoordPair<C>) -> CoordPair<C>

where C: Add<Output = C> + Sub<Output = C> + One,

pub fn checked_move_unit<C>(self, target: &CoordPair<C>) -> Option<CoordPair<C>>

where C: CheckedAdd + CheckedSub + One + Clone,

pub fn checked_move_unit_by_ref<C>( self, target: CoordPair<&C>, ) -> Option<CoordPair<C>>

where C: CheckedAdd + CheckedSub + One + Clone,

pub fn saturating_move_unit<C>(self, target: &CoordPair<C>) -> CoordPair<C>

where C: SaturatingAdd + SaturatingSub + One + Clone,

pub fn saturating_move_unit_by_ref<C>( self, target: CoordPair<&C>, ) -> CoordPair<C>

where C: SaturatingAdd + SaturatingSub + One + Clone,

pub fn move_by<C>(self, magnitude: C, target: CoordPair<C>) -> CoordPair<C>

where C: Add<Output = C> + Sub<Output = C>,

pub fn checked_move_by<C>( self, magnitude: &C, target: &CoordPair<C>, ) -> Option<CoordPair<C>>

where C: CheckedAdd + CheckedSub + Clone,

pub fn checked_move_by_ref_by<C>( self, magnitude: &C, target: CoordPair<&C>, ) -> Option<CoordPair<C>>

where C: CheckedAdd + CheckedSub + Clone,

pub fn saturating_move_by<C>( self, magnitude: &C, target: &CoordPair<C>, ) -> CoordPair<C>

where C: SaturatingAdd + SaturatingSub + Clone,

pub fn saturating_move_by_ref_by<C>( self, magnitude: &C, target: CoordPair<&C>, ) -> CoordPair<C>

where C: SaturatingAdd + SaturatingSub + Clone,

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

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

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

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

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

impl Neg for Direction

type Output = Direction

The resulting type after applying the - operator.

fn neg(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) -> 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 Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction