[−][src]Enum shakmaty::Square
A square index.
Variants
Implementations
impl Square
[src]
pub fn new(index: u32) -> Square
[src]
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
[src]
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
[src]
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>
[src]
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
[src]
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
[src]
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)
[src]
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>
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
impl Copy for Square
[src]
impl Debug for Square
[src]
impl Display for Square
[src]
impl Eq for Square
[src]
impl Extend<Square> for Bitboard
[src]
pub fn extend<T: IntoIterator<Item = Square>>(&mut self, iter: T)
[src]
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl From<(File, Rank)> for Square
[src]
impl From<Square> for Bitboard
[src]
impl FromIterator<Square> for Bitboard
[src]
pub fn from_iter<T>(iter: T) -> Self where
T: IntoIterator<Item = Square>,
[src]
T: IntoIterator<Item = Square>,
impl FromStr for Square
[src]
type Err = ParseSquareError
The associated error which can be returned from parsing.
pub fn from_str(s: &str) -> Result<Square, ParseSquareError>
[src]
impl Hash for Square
[src]
pub fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Square
[src]
pub fn cmp(&self, other: &Square) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Square> for Square
[src]
pub fn eq(&self, other: &Square) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Square> for Square
[src]
pub fn partial_cmp(&self, other: &Square) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for Square
[src]
impl StructuralPartialEq for Square
[src]
impl Sub<Square> for Square
[src]
type Output = i32
The resulting type after applying the -
operator.
pub fn sub(self, other: Square) -> i32
[src]
impl TryFrom<i128> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: i128) -> Result<Square, Self::Error>
[src]
impl TryFrom<i16> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: i16) -> Result<Square, Self::Error>
[src]
impl TryFrom<i32> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: i32) -> Result<Square, Self::Error>
[src]
impl TryFrom<i64> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: i64) -> Result<Square, Self::Error>
[src]
impl TryFrom<i8> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: i8) -> Result<Square, Self::Error>
[src]
impl TryFrom<isize> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: isize) -> Result<Square, Self::Error>
[src]
impl TryFrom<u128> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: u128) -> Result<Square, Self::Error>
[src]
impl TryFrom<u16> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: u16) -> Result<Square, Self::Error>
[src]
impl TryFrom<u32> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: u32) -> Result<Square, Self::Error>
[src]
impl TryFrom<u64> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: u64) -> Result<Square, Self::Error>
[src]
impl TryFrom<u8> for Square
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(value: u8) -> Result<Square, Self::Error>
[src]
impl TryFrom<usize> for Square
[src]
Auto Trait Implementations
impl RefUnwindSafe for Square
[src]
impl Send for Square
[src]
impl Sync for Square
[src]
impl Unpin for Square
[src]
impl UnwindSafe for Square
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,