Struct pgn_reader::SanPlus

pub struct SanPlus {
    pub san: San,
    pub suffix: Option<Suffix>,
}

A San and possible check and checkmate suffixes.

Fields

san: San

suffix: Option<Suffix>

Methods

impl SanPlus

pub fn from_ascii(san: &[u8]) -> Result<SanPlus, ParseSanError>

Parses a SAN and possible check and checkmate suffix.

Errors

Returns ParseSanError if san is not syntactically valid.

pub fn from_move_and_play_unchecked<P>(pos: &mut P, m: &Move) -> SanPlus where
    P: Position, 

Converts a move to Standard Algebraic Notation including possible check and checkmate suffixes. Also plays the move.

It is the callers responsibility to ensure the move is legal.

Panics

Illegal moves can corrupt the state of the position and may (or may not) panic or cause panics on future calls.

pub fn from_move<P>(pos: P, m: &Move) -> SanPlus where
    P: Position, 

Trait Implementations

impl Clone for SanPlus

fn clone(&self) -> SanPlus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl FromStr for SanPlus

type Err = ParseSanError

The associated error which can be returned from parsing.

fn from_str(san: &str) -> Result<SanPlus, ParseSanError>

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

impl Eq for SanPlus

impl PartialEq<SanPlus> for SanPlus

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

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

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

This method tests for !=.

impl Display for SanPlus

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

Formats the value using the given formatter.

impl Hash for SanPlus

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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 Debug for SanPlus

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

Formats the value using the given formatter.