Enum pgn_reader::Square

source · [−]

#[repr(u8)]
pub enum Square {
Show 64 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,
}

Expand description

A square of the chessboard.

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

source

impl Square

source

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

source

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.

source

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

source

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

source

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

source

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

source

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

source

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

source

pub unsafe fn offset_unchecked(self, delta: i32) -> Square

Calculates the offset from a square index without checking for overflow.

Safety

It is the callers responsibility to ensure that delta is a valid offset for self.

source

pub fn xor(self, other: Square) -> Square

Return the bitwise XOR of the numeric square representations. For some operands this is a useful geometric transformation.

source

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

source

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

source

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

source

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

source

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

source

pub fn rotate_180(self) -> Square

Rotate 180 degrees.

use shakmaty::Square;

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

source

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

source

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

source

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

source

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

source

impl Square

source

pub const ALL: [Square ; 64]

A1, B1, …, G8, H8.

Trait Implementations

source

impl Clone for Square

source

pub fn clone(&self) -> Square

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Square

source

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

Formats the value using the given formatter. Read more

source

impl Display for Square

source

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

Formats the value using the given formatter. Read more

source

impl From<(File, Rank )> for Square

source

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

Performs the conversion.

source

impl From<EnPassant> for Square

source

pub fn from(ep: EnPassant) -> Square

Performs the conversion.

source

impl FromStr for Square

type Err = ParseSquareError

The associated error which can be returned from parsing.

source

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

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

source

impl Hash for Square

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl Ord for Square

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<Square> for Square

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl PartialOrd<Square> for Square

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl Sub<Square> for Square

type Output = i32

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl TryFrom<i16> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<i32> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<i64> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<i8> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<isize> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<u16> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<u32> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<u64> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<u8> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<usize> for Square

type Error = TryFromIntError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl StructuralPartialEq for Square

Auto Trait Implementations

impl RefUnwindSafe for Square

impl Send for Square

impl Sync for Square

impl Unpin for Square

impl UnwindSafe for Square

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum pgn_reader::Square

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

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

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

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

pub fn file(self) -> File

pub fn rank(self) -> Rank

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

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

pub unsafe fn offset_unchecked(self, delta: i32) -> Square

pub fn xor(self, other: Square) -> Square

pub fn flip_horizontal(self) -> Square

pub fn flip_vertical(self) -> 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`

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

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

pub const ALL: [Square ; 64]

impl From<(File, Rank )> for Square

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

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

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