Enum thud::Direction

pub enum Direction {
    Up,
    UpRight,
    Right,
    DownRight,
    Down,
    DownLeft,
    Left,
    UpLeft,
}

A cardinal direction on a Board

Variants

Up

UpRight

Right

DownRight

Down

DownLeft

Left

UpLeft

Methods

impl Direction

pub fn all() -> Vec<Self>

Get a Vec containing all the different possible Directions

pub fn from_num(dir: usize) -> Result<Self, ThudError>

pub fn from_route(start: Coord, end: Coord) -> Result<Direction, ThudError>

Use two Coords to get a Direction from one to the other

Returns Err(ThudError::MathError) if:

• The two Coords are not plottable on a straight line together
• The two Coords are equal

pub fn modifier(&self) -> (isize, isize)

Get a tuple representing the changes needed to a Coord in order to "move" it in the Direction given by self.

Example:

use thud::Direction;

assert_eq!(Direction::Up.modifier(), (0, 1));
assert_eq!(Direction::DownLeft.modifier(), (-1, -1));

pub fn modify(&self, loc: Coord) -> Result<Coord, ThudError>

Return a Coord equal to loc offset by one square in the direction given by self.

Returns Err(ThudError::MathError) if this movement would place the Coord out of bounds.

pub fn opposite(&self) -> Self

Get the "opposite" Direction to self.

For example:

use thud::Direction;

assert_eq!(Direction::Up.opposite(), Direction::Down);

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

impl Debug for Direction

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

Formats the value using the given formatter.

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]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for Direction