Enum sark_grids::directions::Dir4

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

Four orthogonal directions on a 2d grid.

Variants

Up

Down

Left

Right

Implementations

impl Dir4

pub fn from_point(p: impl GridPoint) -> Option<Dir4>

Retrieve the direction from the given point, or none if it’s (0,0).

pub fn from_index(i: usize) -> Option<Dir4>

Retrieve a direction from it’s corresponding index.

pub fn to_index(&self) -> usize

Convert a direction to it’s corresponding index.

Trait Implementations

impl Clone for Dir4

fn clone(&self) -> Dir4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir4

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

Formats the value using the given formatter.

impl From<Dir4> for IVec2

fn from(d: Dir4) -> Self

Converts to this type from the input type.

impl PartialEq for Dir4

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

impl Eq for Dir4

impl StructuralPartialEq for Dir4