Enum pgn_reader::Square

#[repr(u8)]pub enum Square {
    A1,
    B1,
    C1,
    D1,
    E1,
    F1,
    G1,
    H1,
    A2,
    B2,
    C2,
    D2,
    E2,
    F2,
    G2,
    H2,
    A3,
    B3,
    C3,
    D3,
    E3,
    F3,
    G3,
    H3,
    A4,
    B4,
    C4,
    D4,
    E4,
    F4,
    G4,
    H4,
    A5,
    B5,
    C5,
    D5,
    E5,
    F5,
    G5,
    H5,
    A6,
    B6,
    C6,
    D6,
    E6,
    F6,
    G6,
    H6,
    A7,
    B7,
    C7,
    D7,
    E7,
    F7,
    G7,
    H7,
    A8,
    B8,
    C8,
    D8,
    E8,
    F8,
    G8,
    H8,
}

A square index.

Variants

A1

B1

C1

D1

E1

F1

G1

H1

A2

B2

C2

D2

E2

F2

G2

H2

A3

B3

C3

D3

E3

F3

G3

H3

A4

B4

C4

D4

E4

F4

G4

H4

A5

B5

C5

D5

E5

F5

G5

H5

A6

B6

C6

D6

E6

F6

G6

H6

A7

B7

C7

D7

E7

F7

G7

H7

A8

B8

C8

D8

E8

F8

G8

H8

Implementations

impl Square

pub fn new(index: u32) -> Square

Gets a Square from an integer index.

Panics

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

Examples

use shakmaty::Square;

assert_eq!(Square::new(0), Square::A1);
assert_eq!(Square::new(63), Square::H8);

pub unsafe fn new_unchecked(index: u32) -> Square

Gets a Square from an integer index.

Safety

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

pub fn from_coords(file: File, rank: Rank) -> Square

Tries to get a square from file and rank.

Examples

use shakmaty::{Square, File, Rank};

assert_eq!(Square::from_coords(File::A, Rank::First), Square::A1);

pub fn from_ascii(s: &[u8]) -> Result<Square, ParseSquareError>

Parses a square name.

Errors

Returns ParseSquareError if the input is not a valid square name in lowercase ASCII characters.

Example

use shakmaty::Square;

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

pub fn file(self) -> File

Gets the file.

Examples

use shakmaty::{Square, File};

assert_eq!(Square::A1.file(), File::A);
assert_eq!(Square::B2.file(), File::B);

pub fn rank(self) -> Rank

Gets the rank.

Examples

use shakmaty::{Square, Rank};

assert_eq!(Square::A1.rank(), Rank::First);
assert_eq!(Square::B2.rank(), Rank::Second);

pub fn coords(self) -> (File, Rank)

Gets file and rank.

Examples

use shakmaty::{Square, File, Rank};

assert_eq!(Square::A1.coords(), (File::A, Rank::First));
assert_eq!(Square::H8.coords(), (File::H, Rank::Eighth));

#[must_use]pub fn offset(self, delta: i32) -> Option<Square>

Calculates the offset from a square index.

Examples

use shakmaty::Square;

assert_eq!(Square::F3.offset(8), Some(Square::F4));
assert_eq!(Square::F3.offset(-1), Some(Square::E3));

assert_eq!(Square::F3.offset(48), None);

#[must_use]pub fn flip_horizontal(self) -> Square

Flip the square horizontally.

use shakmaty::Square;

assert_eq!(Square::H1.flip_horizontal(), Square::A1);
assert_eq!(Square::D3.flip_horizontal(), Square::E3);

#[must_use]pub fn flip_vertical(self) -> Square

Flip the square vertically.

use shakmaty::Square;

assert_eq!(Square::A8.flip_vertical(), Square::A1);
assert_eq!(Square::D3.flip_vertical(), Square::D6);

#[must_use]pub fn flip_diagonal(self) -> Square

Flip at the a1-h8 diagonal by swapping file and rank.

use shakmaty::Square;

assert_eq!(Square::A1.flip_diagonal(), Square::A1);
assert_eq!(Square::A3.flip_diagonal(), Square::C1);

#[must_use]pub fn flip_anti_diagonal(self) -> Square

Flip at the h1-a8 diagonal.

use shakmaty::Square;

assert_eq!(Square::A1.flip_anti_diagonal(), Square::H8);
assert_eq!(Square::A3.flip_anti_diagonal(), Square::F8);

#[must_use]pub fn rotate_90(self) -> Square

Rotate 90 degrees clockwise.

use shakmaty::Square;

assert_eq!(Square::A1.rotate_90(), Square::A8);
assert_eq!(Square::A3.rotate_90(), Square::C8);

#[must_use]pub fn rotate_180(self) -> Square

Rotate 180 degrees clockwise.

use shakmaty::Square;

assert_eq!(Square::A1.rotate_180(), Square::H8);
assert_eq!(Square::A3.rotate_180(), Square::H6);

#[must_use]pub fn rotate_270(self) -> Square

Rotate 270 degrees clockwise.

use shakmaty::Square;

assert_eq!(Square::A1.rotate_270(), Square::H1);
assert_eq!(Square::A3.rotate_270(), Square::F1);

pub 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());

pub 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());

pub fn distance(self, other: Square) -> u32

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);

Trait Implementations

impl Clone for Square

pub fn clone(&self) -> Square

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Square

impl Debug for Square

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

Formats the value using the given formatter.

impl Display for Square

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

Formats the value using the given formatter.

impl Eq for Square

impl From<(File, Rank)> for Square

pub fn from((File, Rank)) -> Square

Performs the conversion.

impl From<EpSquare> for Square

pub fn from(EpSquare) -> Square

Performs the conversion.

impl FromStr for Square

type Err = ParseSquareError

The associated error which can be returned from parsing.

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

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

impl Hash for Square

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Square

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Square> for Square

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Square> for Square

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Square

impl StructuralPartialEq for Square

impl Sub<Square> for Square

type Output = i32

The resulting type after applying the - operator.

pub fn sub(self, other: Square) -> i32

Performs the - operation.

impl TryFrom<i16> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: i16) -> Result<Square, <Square as TryFrom<i16>>::Error>

Performs the conversion.

impl TryFrom<i32> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: i32) -> Result<Square, <Square as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<i64> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: i64) -> Result<Square, <Square as TryFrom<i64>>::Error>

Performs the conversion.

impl TryFrom<i8> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: i8) -> Result<Square, <Square as TryFrom<i8>>::Error>

Performs the conversion.

impl TryFrom<isize> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: isize
) -> Result<Square, <Square as TryFrom<isize>>::Error>

Performs the conversion.

impl TryFrom<u16> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: u16) -> Result<Square, <Square as TryFrom<u16>>::Error>

Performs the conversion.

impl TryFrom<u32> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: u32) -> Result<Square, <Square as TryFrom<u32>>::Error>

Performs the conversion.

impl TryFrom<u64> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: u64) -> Result<Square, <Square as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<u8> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(value: u8) -> Result<Square, <Square as TryFrom<u8>>::Error>

Performs the conversion.

impl TryFrom<usize> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: usize
) -> Result<Square, <Square as TryFrom<usize>>::Error>

Performs the conversion.