Struct shogi::square::Square

pub struct Square { /* fields omitted */ }

Represents a position of each cell in the game board.

Examples

use shogi::Square;

let sq = Square::new(4, 4).unwrap();
assert_eq!("5e", sq.to_string());

Square can be created by parsing a SFEN formatted string as well.

use shogi::Square;

let sq = Square::from_sfen("5e").unwrap();
assert_eq!(4, sq.file());
assert_eq!(4, sq.rank());

Methods

impl Square

pub fn new(file: u8, rank: u8) -> Option<Square>

Creates a new instance of Square.

file can take a value from 0('1') to 8('9'), while rank is from 0('a') to 9('i').

pub fn from_sfen(s: &str) -> Option<Square>

Creates a new instance of Square from SFEN formatted string.

pub fn from_index(index: u8) -> Option<Square>

Creates a new instance of Square with the given index value.

Important traits for SquareIter

impl Iterator for SquareIter type Item = Square;

pub fn iter() -> SquareIter

Returns an iterator of all variants.

pub fn file(&self) -> u8

Returns a file of the square.

pub fn rank(&self) -> u8

Returns a rank of the square.

pub fn shift(&self, df: i8, dr: i8) -> Option<Square>

Returns a new Square instance by moving the file and the rank values.

Examples

use shogi::square::consts::*;

let sq = SQ_2B;
let shifted = sq.shift(2, 3).unwrap();

assert_eq!(3, shifted.file());
assert_eq!(4, shifted.rank());

pub fn relative_rank(&self, c: Color) -> u8

Returns a relative rank as if the specified color is black.

Examples

use shogi::Color;
use shogi::square::consts::*;

let sq = SQ_1G;

assert_eq!(6, sq.relative_rank(Color::Black));
assert_eq!(2, sq.relative_rank(Color::White));

pub fn in_promotion_zone(&self, c: Color) -> bool

Tests if the square is in a promotion zone.

pub fn index(&self) -> usize

Converts the instance into the unique number for array indexing purpose.

Trait Implementations

impl PartialEq<Square> for Square

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

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

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

This method tests for !=.

impl Eq 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 Copy for Square

impl Display for Square

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

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.

impl Hash for Square

fn hash<__H: Hasher>(&self, state: &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<'a> BitAnd<Square> for &'a Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn bitand(self, rhs: Square) -> Bitboard

Performs the & operation.

impl<'a> BitOr<Square> for &'a Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn bitor(self, rhs: Square) -> Bitboard

Performs the | operation.

impl<'a> BitXor<Square> for &'a Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn bitxor(self, rhs: Square) -> Bitboard

Performs the ^ operation.

impl<'a> BitAndAssign<Square> for Bitboard

fn bitand_assign(&mut self, rhs: Square)

Performs the &= operation.

impl<'a> BitOrAssign<Square> for Bitboard

fn bitor_assign(&mut self, rhs: Square)

Performs the |= operation.

impl<'a> BitXorAssign<Square> for Bitboard

fn bitxor_assign(&mut self, rhs: Square)

Performs the ^= operation.