Struct grid2d::Coordinate

pub struct Coordinate { /* private fields */ }

Coordinate of a cell on a two-dimensional grid

Implementations

impl Coordinate

pub fn new(x: usize, y: usize) -> Self

Creates a new coordinate

Arguments

• x - The x component
• y - The y component

pub fn from_width_and_index(width: usize, index: usize) -> Self

Creates a coordinate from a grid’s width and a total index

Arguments

• width - The grid’s width
• index - The index of the cell

pub fn from_str_pair((x, y): (&str, &str)) -> Result<Self, CoordinateParseError>

Creates a coordinate from a tuple of two string slices on success or returns an error code

Arguments

• (x, y) - Tuple of the x and y component as string slices

pub fn x(&self) -> usize

Returns the x component

pub fn y(&self) -> usize

Returns the y component

pub fn to_index(&self, width: usize) -> usize

Converts the coordinate into a linear index

Arguments

• width - The width of the grid

pub fn neighbors(&self) -> Vec<Coordinate>

Returns all potential neighboring coordinates

Trait Implementations

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Coordinate

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

Formats the value using the given formatter.

impl Display for Coordinate

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

Formats the value using the given formatter.

impl From<&(usize, usize)> for Coordinate

fn from((x, y): &(usize, usize)) -> Self

Converts to this type from the input type.

impl From<&Coordinate> for (usize, usize)

fn from(coordinate: &Coordinate) -> Self

Converts to this type from the input type.

impl From<&Coordinate> for Coordinate

fn from(coordinate: &Coordinate) -> Self

Converts to this type from the input type.

impl From<(usize, usize)> for Coordinate

fn from((x, y): (usize, usize)) -> Self

Converts to this type from the input type.

impl From<Coordinate> for (usize, usize)

fn from(coordinate: Coordinate) -> Self

Converts to this type from the input type.

impl FromStr for Coordinate

type Err = CoordinateParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Coordinate

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<Coordinate> for Coordinate

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

impl Eq for Coordinate

impl StructuralEq for Coordinate

impl StructuralPartialEq for Coordinate