Struct hex_game::coord::Coord

pub struct Coord {
    pub x: u8,
    pub y: u8,
}

A coordinate on a Hex board, such that (x, y) = (0, 0) is the top left and (1, 0) is the hex immediately to the right of that hex. Cannot support boards larger than 128x128 for performance reasons.

Fields

x: u8

The x-axis, starting from the left column at 0.

y: u8

The y-axis, starting from the top row at 0.

Methods

impl Coord

pub fn new(x: u8, y: u8) -> Option<Coord>

Creates a new Coord, returning None if either x or y exceed 25.

pub fn neighbors(self) -> Vec<Coord>

Returns an iterator representing each of this hex's neighbors, clockwise from the top left. If this hex is on the first row or column, will return fewer than six coordinates.

pub fn is_neighbor(self, other: Coord) -> bool

Returns true if the two hexes neighbor each other or equal each other, and false otherwise.

pub fn abs_sub(int1: u8, int2: u8) -> u8

Gets the absolute difference between two unsigned u8s, in a way that avoids overflow.

pub fn distance(self, other: Coord) -> u8

Gets the distance between two coordinates, defined as the number of steps in the grid needed to connect them. A distance of 0 means equality, and a distance of 1 means the two are neighboring.

Trait Implementations

impl Eq for Coord

impl Copy for Coord

impl Default for Coord

fn default() -> Coord

Returns the "default value" for a type.

impl PartialEq<Coord> for Coord

fn eq(&self, other: &Coord) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Coord) -> bool

This method tests for !=.

impl Clone for Coord

fn clone(&self) -> Coord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Coord

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

Formats the value using the given formatter.

impl Display for Coord

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

Formats the value using the given formatter.

impl Hash for Coord

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,

Feeds a slice of this type into the given [Hasher].

impl Add<Coord> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, rhs: Coord) -> Self::Output

Adds componentwise, but does not check the addition.

impl FromStr for Coord

type Err = ParseCoordError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.