#[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
impl Square
sourcepub const unsafe fn new_unchecked(index: u32) -> Square
pub const 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
.
sourcepub fn from_coords(file: File, rank: Rank) -> Square
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);
sourcepub fn from_ascii(s: &[u8]) -> Result<Square, ParseSquareError>
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);
sourcepub fn file(self) -> File
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);
sourcepub fn rank(self) -> Rank
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);
sourcepub fn coords(self) -> (File, Rank)
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));
sourcepub fn offset(self, delta: i32) -> Option<Square>
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);
sourcepub unsafe fn offset_unchecked(self, delta: i32) -> Square
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
.
sourcepub fn xor(self, other: Square) -> Square
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.
sourcepub fn flip_horizontal(self) -> Square
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);
sourcepub fn flip_vertical(self) -> Square
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);
sourcepub fn flip_diagonal(self) -> Square
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);
sourcepub fn flip_anti_diagonal(self) -> Square
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);
sourcepub fn rotate_90(self) -> Square
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);
sourcepub fn rotate_180(self) -> Square
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);
sourcepub fn rotate_270(self) -> Square
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);
sourcepub fn is_light(self) -> bool
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());
Trait Implementations§
source§impl Extend<Square> for Bitboard
impl Extend<Square> for Bitboard
source§fn extend<T: IntoIterator<Item = Square>>(&mut self, iter: T)
fn extend<T: IntoIterator<Item = Square>>(&mut self, iter: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<Square> for Bitboard
impl FromIterator<Square> for Bitboard
source§impl Ord for Square
impl Ord for Square
source§impl PartialOrd<Square> for Square
impl PartialOrd<Square> for Square
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Step for Square
Available on crate feature step
only.
impl Step for Square
step
only.source§fn steps_between(start: &Self, end: &Self) -> Option<usize>
fn steps_between(start: &Self, end: &Self) -> Option<usize>
step_trait
)source§fn forward_checked(start: Self, count: usize) -> Option<Self>
fn forward_checked(start: Self, count: usize) -> Option<Self>
step_trait
)source§fn backward_checked(start: Self, count: usize) -> Option<Self>
fn backward_checked(start: Self, count: usize) -> Option<Self>
step_trait
)source§unsafe fn forward_unchecked(start: Self, count: usize) -> Self
unsafe fn forward_unchecked(start: Self, count: usize) -> Self
step_trait
)source§unsafe fn backward_unchecked(start: Self, count: usize) -> Self
unsafe fn backward_unchecked(start: Self, count: usize) -> Self
step_trait
)impl Copy for Square
impl Eq for Square
impl IsEnabled for Square
nohash-hasher
only.