Enum ruscii::spatial::Direction

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

The relative directions in a two-dimensional coordinate system, including up, down, left, right, and none.

Variants

Up

Down

Right

Left

None

Implementations

impl Direction

pub fn opposite(&self) -> Direction

Returns the opposite Direction.

For Direction::None, Direction::None is returned.

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 From<Direction> for Vec2

fn from(value: Direction) -> Self

Converts a Direction to a unit-length Vec2 in that direction.

Because terminal coordinates begin at the top line, vertical directions are inverted compared to what you may expect. More information in the example. For Direction::None, a zero Vec2 is returned.

Example

In the terminal, y increases going downward from the top. Therefore, Direction::Up is a negative vector and Direction::Down is a positive vector.

let up = Vec2::from(Direction::Up);
let down = Vec2::from(Direction::Down);

assert_eq!(up, Vec2::y(-1));
assert_eq!(down, Vec2::y(1));

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 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 TryFrom<Vec2> for Direction

fn try_from(value: Vec2) -> Result<Self, Self::Error>

Converts a Vec2 to a Direction.

Because terminal coordinates begin at the top line, vertical directions are inverted compared to what you may expect. For more information, see the example.

Errors

If the given value is not orthogonal, i.e., one of the components is not zero, TryFromVec2Error is returned.

Examples

In the terminal, y increases going downward from the top. Therefore, Direction::Up is a negative vector and Direction::Down is a positive vector.

let negative_y = Direction::try_from(Vec2::y(-1)).unwrap();
let positive_y = Direction::try_from(Vec2::y(1)).unwrap();

assert_eq!(negative_y, Direction::Up);
assert_eq!(positive_y, Direction::Down);

Passing non-orthogonal vectors, that is, vectors that are neither parallel to the x- or y-axis will result in an error.

Direction::try_from(Vec2::xy(1, 1)).unwrap();  // panics!

type Error = TryFromVec2Error

The type returned in the event of a conversion error.

impl Copy for Direction

impl Eq for Direction

impl StructuralEq for Direction

impl StructuralPartialEq for Direction