Struct Identifier 

pub struct Identifier { /* private fields */ }

A parsed PIN token: the identity of a piece at the level of notation.

An Identifier bundles the four attributes a token encodes — a Letter abbreviation, a Side, a State, and a terminal flag — into a single 4-byte Copy value. Construction from typed components via Identifier::new is total: every combination is a valid token, so it cannot fail.

The derived total ordering compares attributes in the order letter → side → state → terminal.

Examples

use sashite_pin::{Identifier, Side, State};

let rook: Identifier = "+r".parse()?;
assert_eq!(rook.letter().as_char(), 'R');
assert_eq!(rook.side(), Side::Second);
assert_eq!(rook.state(), State::Enhanced);
assert!(!rook.is_terminal());

// Transformations are cheap and infallible; the value is `Copy`.
assert_eq!(rook.flipped().normalized().encode().as_str(), "R");

Implementations

impl Identifier

pub const fn new( letter: Letter, side: Side, state: State, terminal: bool, ) -> Self

Builds an identifier from its four typed components.

This is infallible: because each component type is valid by construction, every combination denotes a valid PIN token.

Examples

use sashite_pin::{Identifier, Letter, Side, State};

let p = Identifier::new(
    Letter::try_from_char('R').unwrap(),
    Side::Second,
    State::Enhanced,
    false,
);
assert_eq!(p.encode().as_str(), "+r");

pub const fn parse(input: &str) -> Result<Self, ParseError>

Parses a string slice into an identifier.

Errors

Returns a ParseError if input is not a valid PIN token (empty, too long, or malformed).

Examples

use sashite_pin::Identifier;

let king = Identifier::parse("K^")?;
assert!(king.is_first());
assert!(king.is_terminal());

pub const fn is_valid(input: &str) -> bool

Reports whether input is a valid PIN token, without allocating or constructing an identifier on the caller’s side.

pub fn encode(self) -> EncodedPin

Returns the canonical, allocation-free string encoding of this token.

pub const fn letter(self) -> Letter

Returns the piece-name abbreviation (always uppercase).

pub const fn side(self) -> Side

Returns the side the piece belongs to.

pub const fn state(self) -> State

Returns the piece state.

pub const fn is_terminal(self) -> bool

Reports whether the piece is terminal (the ^ marker is present).

pub const fn is_normal(self) -> bool

Reports whether the state is State::Normal.

pub const fn is_enhanced(self) -> bool

Reports whether the state is State::Enhanced.

pub const fn is_diminished(self) -> bool

Reports whether the state is State::Diminished.

pub const fn is_first(self) -> bool

Reports whether the side is Side::First.

pub const fn is_second(self) -> bool

Reports whether the side is Side::Second.

pub const fn with_letter(self, letter: Letter) -> Self

Returns a copy with the abbreviation replaced.

pub const fn with_side(self, side: Side) -> Self

Returns a copy with the side replaced.

pub const fn with_state(self, state: State) -> Self

Returns a copy with the state replaced.

pub const fn with_terminal(self, terminal: bool) -> Self

Returns a copy with the terminal flag replaced.

pub const fn enhanced(self) -> Self

Returns a copy in the State::Enhanced state.

pub const fn diminished(self) -> Self

Returns a copy in the State::Diminished state.

pub const fn normalized(self) -> Self

Returns a copy in the baseline State::Normal state.

pub const fn flipped(self) -> Self

Returns a copy belonging to the opposite Side.

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Identifier

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Identifier

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

Formats the value using the given formatter.

impl FromStr for Identifier

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Identifier

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

Feeds a slice of this type into the given Hasher.

impl Ord for Identifier

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Identifier

fn eq(&self, other: &Identifier) -> 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 PartialOrd for Identifier

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Identifier

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Identifier

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Identifier

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Identifier

impl Eq for Identifier

impl StructuralPartialEq for Identifier