Struct pgn_reader::Nag

pub struct Nag(pub u8);

A numeric annotation glyph like ?, !! or $42.

Methods

impl Nag

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

Tries to parse a NAG from ASCII.

Examples

use pgn_reader::Nag;

assert_eq!(Nag::from_ascii(b"??"), Ok(Nag(4)));
assert_eq!(Nag::from_ascii(b"$24"), Ok(Nag(24)));

Errors

Returns an InvalidNag error if the input is neither a known glyph (?!, !, ...) nor a valid numeric annotation ($0, ..., $255).

pub const GOOD_MOVE: Nag

A good move (!).

pub const MISTAKE: Nag

A mistake (?).

pub const BRILLIANT_MOVE: Nag

A brilliant move (!!).

pub const BLUNDER: Nag

A blunder (??).

pub const SPECULATIVE_MOVE: Nag

A speculative move (!?).

pub const DUBIOUS_MOVE: Nag

A dubious move (?!).

Trait Implementations

impl PartialOrd<Nag> for Nag

fn partial_cmp(&self, other: &Nag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Nag) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Nag) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Nag) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Nag) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Nag> for Nag

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

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

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

This method tests for !=.

impl From<u8> for Nag

fn from(nag: u8) -> Nag

Performs the conversion.

impl Clone for Nag

fn clone(&self) -> Nag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Nag

fn cmp(&self, other: &Nag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for Nag

impl Display for Nag

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

Formats the value using the given formatter.

impl Debug for Nag

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

Formats the value using the given formatter.

impl Hash for Nag

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 FromStr for Nag

type Err = InvalidNag

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Nag, InvalidNag>

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