Struct pgn4::PGN4

pub struct PGN4 {
    pub bracketed: Vec<(String, String)>,
    pub turns: Vec<Turn>,
}

Representation of pgn4 file

TODO: general description

Notably, Chess.com does not support variations within variations whereas this tool does. If you try to import a pgn4 with recursive variations into Chess.com, you will get errors.

Fields

bracketed: Vec<(String, String)>

PGN4 files have a list of key value pairs in the beginning that specify variants, time control, and other metadata

turns: Vec<Turn>

The game is stored as a list of Turns which hold up to 4 QuarterTurns each. Unfortunately, this cannot be simplified to a single list without compromising round-trip serilization or including enough logic to deduce which player’s turn it is.

If you need to follow sub-variations, please use a Visitor

Implementations

impl PGN4

pub fn tag<'a>(&'a self, tag_name: &str) -> Option<&'a str>

Searches for a tag and optionally returns a reference to it if found

pub fn variant(&self) -> Result<Variant, VariantError>

Extract / parse the variant from a pgn4

pub fn ratings(&self) -> Option<[u16; 4]>

If all four players are rated, parse all of the ratings.

pub fn players(&self) -> Option<[&str; 4]>

If all players have names, return a reference to them

pub fn result(&self) -> GameResult

If tag “Result” is present, parse it.

pub fn append_move(
    &mut self,
    path: &[usize],
    q: QuarterTurn
) -> Result<usize, ()>

Inserts q after path in self and returns the index of the alternative where the move was placed (0 for continuing the line).

Format for path is [ply forward] : [alternative index, plyforward]* In order to follow it, move to the next move path[0] times, then if there is more to path, go into alternative path[1]-1 and continue with path[2..] This is the format Chess.com uses to notate with

pub fn promote_to_mainline(&mut self, path: &[usize]) -> Result<(), ()>

Switches the order of alternatives / main moves such that the given path ends up as the mainline

pub fn delete_from(&mut self, path: &[usize]) -> Result<(), ()>

Deletes all further moves after path and path istself. Any alternatives to it remain.

Trait Implementations

impl Clone for PGN4

fn clone(&self) -> PGN4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PGN4

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

Formats the value using the given formatter.

impl Display for PGN4

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

Formats the value using the given formatter.

impl FromStr for PGN4

type Err = PGN4Error

The associated error which can be returned from parsing.

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

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

impl PartialEq<PGN4> for PGN4

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

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

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

This method tests for !=.

impl StructuralPartialEq for PGN4