Type Definition shakmaty::Material

pub type Material = ByColor<MaterialSide>;

The material configuration of both sides.

Implementations

impl Material

pub fn new() -> Material

pub fn by_piece(&self, piece: Piece) -> u8

pub fn by_piece_mut(&mut self, piece: Piece) -> &mut u8

pub fn is_empty(&self) -> bool

pub fn count(&self) -> usize

pub fn has_pawns(&self) -> bool

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

Parse material from notation like KPPvKR.

Errors

Returns ParseMaterialError if there are any unrecognized characters, not exactly one v to separate white pieces from black pieces, or more than 64 pieces.

Examples

use shakmaty::Material;

let material = Material::from_ascii(b"KPPvKR")?;
assert_eq!(material.white.kings, 1);
assert_eq!(material.white.pawns, 2);
assert_eq!(material.black.kings, 1);
assert_eq!(material.black.rooks, 1);

pub fn from_ascii_fen(s: &[u8]) -> Result<Material, ParseMaterialError>

Parse material from notation like KPPkr, where white pieces are uppercase characters and black pieces are lowercase characters.

Errors

Returns ParseMaterialError if there are any unrecognized characters, or more than 64 pieces.

Examples

use shakmaty::Material;

let material = Material::from_ascii_fen(b"KPPkr")?;
assert_eq!(material.white.kings, 1);
assert_eq!(material.white.pawns, 2);
assert_eq!(material.black.kings, 1);
assert_eq!(material.black.rooks, 1);

pub fn fen(&self) -> String

Trait Implementations

impl<'a> Add<&'a ByColor<MaterialSide>> for Material

type Output = Material

The resulting type after applying the + operator.

fn add(self, other: &'a Material) -> Material

Performs the + operation.

impl Add<ByColor<MaterialSide>> for Material

type Output = Material

The resulting type after applying the + operator.

fn add(self, other: Material) -> Material

Performs the + operation.

impl<'a> AddAssign<&'a ByColor<MaterialSide>> for Material

fn add_assign(&mut self, other: &'a Material)

Performs the += operation.

impl AddAssign<ByColor<MaterialSide>> for Material

fn add_assign(&mut self, other: Material)

Performs the += operation.

impl Display for Material

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

Formats the value using the given formatter.

impl Extend<Piece> for Material

fn extend<T: IntoIterator<Item = Piece>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Piece> for Material

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Piece>, 

Creates a value from an iterator.

impl FromStr for Material

type Err = ParseMaterialError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Material, ParseMaterialError>

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

impl<'a> Sub<&'a ByColor<MaterialSide>> for Material

type Output = Material

The resulting type after applying the - operator.

fn sub(self, other: &'a Material) -> Material

Performs the - operation.

impl Sub<ByColor<MaterialSide>> for Material

type Output = Material

The resulting type after applying the - operator.

fn sub(self, other: Material) -> Material

Performs the - operation.

impl<'a> SubAssign<&'a ByColor<MaterialSide>> for Material

fn sub_assign(&mut self, other: &'a Material)

Performs the -= operation.

impl SubAssign<ByColor<MaterialSide>> for Material

fn sub_assign(&mut self, other: Material)

Performs the -= operation.