Struct SquareCoordinates 

pub struct SquareCoordinates(/* private fields */);

SquareCoordinates is a struct that represents the coordinates of a square on a chess board.

The coordinates are represented internally as a single usize value.

Examples

use chessly::SquareCoordinates;

let square = SquareCoordinates::new(0, 0);
assert_eq!(square.file(), 0);
assert_eq!(square.rank(), 0);
assert_eq!(square.to_string(), "a1");

let square = SquareCoordinates::try_from("h8").unwrap();
assert_eq!(square.file(), 7);
assert_eq!(square.rank(), 7);

Implementations

impl SquareCoordinates

pub fn new(file: u8, rank: u8) -> Self

Creates a new SquareCoordinates from a file and a rank.

File and rank are zero-indexed.

Panics

Panics if file or rank is out of range.

Examples

use chessly::SquareCoordinates;

let square = SquareCoordinates::new(3, 5);
assert_eq!(square.file(), 3);
assert_eq!(square.rank(), 5);
assert_eq!(square.to_string(), "d6");

impl SquareCoordinates

pub const fn file(&self) -> u8

Returns the file (zero-indexed) of the square.

Examples

use chessly::SquareCoordinates;

let square = SquareCoordinates::new(3, 5);
assert_eq!(square.file(), 3);

pub const fn rank(&self) -> u8

Returns the rank (zero-indexed) of the square.

Examples

use chessly::SquareCoordinates;

let square = SquareCoordinates::new(3, 5);
assert_eq!(square.rank(), 5);

pub const fn board_index(&self) -> usize

Returns the index of the square on the board (zero-indexed).

Examples

use chessly::SquareCoordinates;

let square = SquareCoordinates::new(3, 5);
assert_eq!(square.board_index(), 43);

Trait Implementations

impl Clone for SquareCoordinates

fn clone(&self) -> SquareCoordinates

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SquareCoordinates

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

Formats the value using the given formatter.

impl Display for SquareCoordinates

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

Formats the value using the given formatter.

impl PartialEq for SquareCoordinates

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for SquareCoordinates

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for SquareCoordinates

impl Eq for SquareCoordinates

impl StructuralPartialEq for SquareCoordinates