Struct Square 

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

A chessboard square stored in canonical A1-to-H8 order.

Implementations

impl Square

pub const fn new(file: File, rank: Rank) -> Self

Creates a square from its file and rank.

Examples

use chessnut_move::protocol::{File, Rank, Square};

let square = Square::new(File::E, Rank::Four);
assert_eq!(square.to_string(), "e4");

pub const fn from_index(index: usize) -> Option<Self>

Creates a square from a canonical zero-based index.

Returns None when index is not less than SQUARE_COUNT.

Examples

use chessnut_move::protocol::{File, Rank, Square};

assert_eq!(Square::from_index(0), Some(Square::new(File::A, Rank::One)));
assert_eq!(Square::from_index(64), None);

pub const fn index(self) -> usize

Returns the canonical zero-based A1-to-H8 index.

Examples

use chessnut_move::protocol::{File, Rank, Square};

assert_eq!(Square::new(File::A, Rank::One).index(), 0);
assert_eq!(Square::new(File::H, Rank::Eight).index(), 63);

pub const fn file(self) -> File

Returns the square’s file.

Examples

use chessnut_move::protocol::{File, Rank, Square};

assert_eq!(Square::new(File::C, Rank::Six).file(), File::C);

pub const fn rank(self) -> Rank

Returns the square’s rank.

Examples

use chessnut_move::protocol::{File, Rank, Square};

assert_eq!(Square::new(File::C, Rank::Six).rank(), Rank::Six);

Trait Implementations

impl Clone for Square

fn clone(&self) -> Square

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Square

impl Debug for Square

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

Formats the value using the given formatter.

impl Display for Square

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

Formats the value using the given formatter.

impl Eq for Square

impl From<Square> for usize

fn from(square: Square) -> Self

Converts to this type from the input type.

impl FromStr for Square

type Err = ParseSquareError

The associated error which can be returned from parsing.

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

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

impl Hash for Square

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 Ord for Square

fn cmp(&self, other: &Square) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Square

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Square

fn partial_cmp(&self, other: &Square) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Square