Struct shogi::piece::Piece

pub struct Piece {
    pub piece_type: PieceType,
    pub color: Color,
}

Represents a piece on the game board.

Fields

piece_type: PieceType

color: Color

Methods

impl Piece

pub fn from_sfen(c: char) -> Option<Piece>

Creates a new instance of Piece from SFEN formatted string.

pub fn promote(&self) -> Option<Piece>

Returns an instance of Piece after promotion.

Examples

use shogi::{Color, PieceType, Piece};

let pc1 = Piece{piece_type: PieceType::Pawn, color: Color::Black};
let pc2 = Piece{piece_type: PieceType::ProPawn, color: Color::Black};

assert_eq!(Some(pc2), pc1.promote());
assert_eq!(None, pc2.promote());

pub fn unpromote(&self) -> Option<Piece>

Returns an instance of Piece before promotion.

Examples

use shogi::{Color, PieceType, Piece};

let pc1 = Piece{piece_type: PieceType::Pawn, color: Color::Black};
let pc2 = Piece{piece_type: PieceType::ProPawn, color: Color::Black};

assert_eq!(Some(pc1), pc2.unpromote());
assert_eq!(None, pc1.unpromote());

pub fn flip(&self) -> Piece

Returns an instance of Piece with the reversed color.

Examples

use shogi::{Color, PieceType, Piece};

let pc1 = Piece{piece_type: PieceType::Pawn, color: Color::Black};
let pc2 = Piece{piece_type: PieceType::Pawn, color: Color::White};

assert_eq!(pc2, pc1.flip());
assert_eq!(pc1, pc2.flip());

pub fn is_placeable_at(&self, sq: Square) -> bool

Tests if it is legal to place this piece at the given square.

Trait Implementations

impl PartialEq<Piece> for Piece

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

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

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

This method tests for !=.

impl Eq for Piece

impl Clone for Piece

fn clone(&self) -> Piece

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Piece

impl Display for Piece

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

Formats the value using the given formatter.

impl Debug for Piece

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

Formats the value using the given formatter.