Struct 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>

Implementations

impl SanPlus

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

Parses the given ASCII bytes as a move in SAN and possible check or checkmate suffix.

Errors

Errors with ParseSanError if ascii is not syntactically valid.

pub fn from_ascii_prefix( ascii: &[u8], ) -> Result<(SanPlus, usize), ParseSanError>

Parses a move in SAN and possible check and checkmate suffix from the start of the given ASCII bytes.

Every byte that might continue a move in SAN is eagerly consumed without backtracking.

Returns the parsed SAN and the number of bytes consumed.

Errors

Errors with ParseSanError if ascii does not start with a syntactically valid SAN or if backtracking would be required to parse it.

For example, even though Nf3=X starts with Nf3, the parser commits to Nf3= and then fails on X.

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,

pub fn append_to_string(self, s: &mut String)

pub fn append_ascii_to(self, buf: &mut Vec<u8>)

Trait Implementations

impl Clone for SanPlus

fn clone(&self) -> SanPlus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SanPlus

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

Formats the value using the given formatter.

impl Display for SanPlus

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

Formats the value using the given formatter.

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 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SanPlus

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SanPlus

impl Eq for SanPlus

impl StructuralPartialEq for SanPlus