Struct shakmaty::square::Square

pub struct Square(_);

A square index.

Methods

impl Square

fn new(index: i8) -> Square

Create a Square from in integer index.

Panics

Panics if the index is not in the range 0..=63.

fn from_index(index: i8) -> Option<Square>

Tries to create a Square from an integer index in the range 0..=63.

unsafe fn from_index_unchecked(index: i8) -> Square

Creates a Square from an integer index.

Unsafety

It is the callers responsibility to ensure it is in the range 0..=63.

fn from_coords(file: i8, rank: i8) -> Option<Square>

Tries to create a square from zero-based file and rank indexes.

unsafe fn from_coords_unchecked(file: i8, rank: i8) -> Square

Creates a Square from zero-based file and rank indexes.

Unsafety

It is the callers responsibility to ensure that file and rank are in the range 0..=7.

fn from_bytes(s: &[u8]) -> Result<Square, InvalidSquareName>

Parses a square name.

Errors

Errors when the input is not a valid square name in lowercase ASCII characters.

Example

use shakmaty::square;

let sq = Square::from_bytes(b"a5")?;
assert_eq!(sq, square::A5);

fn index(self) -> i8

fn file(self) -> i8

fn file_char(self) -> char

fn rank(self) -> i8

fn rank_char(self) -> char

fn offset(self, delta: i8) -> Option<Square>

fn is_light(self) -> bool

Tests is the square is a light square.

use shakmaty::square;

assert!(square::D1.is_light());
assert!(!square::D8.is_light());

fn is_dark(self) -> bool

Tests is the square is a dark square.

use shakmaty::square;

assert!(square::E1.is_dark());
assert!(!square::E8.is_dark());

fn distance(self, other: Square) -> i8

The distance between the two squares, i.e. the number of king steps to get from one square to the other.

use shakmaty::square;

assert_eq!(square::A2.distance(square::B5), 3);

fn combine(self, rank: Square) -> Square

Combines two squares, taking the file from the first and the rank from the second.

use shakmaty::square;

assert_eq!(square::D3.combine(square::F5), square::D5);

Trait Implementations

impl Copy for Square

impl Clone for Square

fn clone(&self) -> Square

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Square

impl PartialEq for Square

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

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

fn ne(&self, __arg_0: &Square) -> bool

This method tests for !=.

impl Ord for Square

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

This method returns an Ordering between self and other.

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

🔬 This is a nightly-only experimental API. (ord_max_min)

Compares and returns the maximum of two values.

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

🔬 This is a nightly-only experimental API. (ord_max_min)

Compares and returns the minimum of two values.

impl PartialOrd for Square

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

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

fn lt(&self, __arg_0: &Square) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Square) -> bool

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

fn gt(&self, __arg_0: &Square) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Square) -> bool

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

impl Hash for Square

fn hash<__H: Hasher>(&self, __arg_0: &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 Sub for Square

type Output = i8

The resulting type after applying the - operator.

fn sub(self, Square: Square) -> i8

Performs the - operation.

impl FromStr for Square

type Err = InvalidSquareName

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Square, InvalidSquareName>

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

impl Display for Square

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

Formats the value using the given formatter.

impl Debug for Square

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

Formats the value using the given formatter.