Enum GameTree

pub enum GameTree {
    GoGame(SgfNode<Prop>),
    Unknown(SgfNode<Prop>),
}

An SGF GameTree value.

This type allows creating a collection of SgfNode values for different games. This is used in the return type of the parse function. Users of the serialize function will need to build these.

For now, all non-Go games will parse as GameTree::Unknown which should also be used for any serialization of non-Go games.

Variants

GoGame(SgfNode<Prop>)

Unknown(SgfNode<Prop>)

Implementations

impl GameTree

pub fn into_go_node(self) -> Result<SgfNode<Prop>, SgfParseError>

Consumes a Go game GameTree and returns the contained SgfNode.

This is a convenience method for go games.

Errors

Returns an error if the variant isn’t a GameTree::GoGame.

Examples

use sgf_parse::parse;

let gametree = parse("(;B[de]C[A comment])").unwrap().into_iter().next().unwrap();
let sgf_node = gametree.into_go_node().unwrap();

pub fn as_go_node(&self) -> Result<&SgfNode<Prop>, SgfParseError>

Return a reference to the root SgfNode of the tree.

This is a convenience method for go games.

Errors

Returns an error if the variant isn’t a GameTree::GoGame.

Examples

use sgf_parse::parse;

let gametrees = parse("(;B[de]C[A comment])").unwrap();
let sgf_node = gametrees.first().unwrap().as_go_node().unwrap();

pub fn gametype(&self) -> GameType

Returns the GameType for this GameTree.

Examples

use sgf_parse::{parse, GameType};

let gametree = parse("(;GM[1]B[de]C[A comment])").unwrap().into_iter().next().unwrap();
assert_eq!(gametree.gametype(), GameType::Go);

Trait Implementations

impl Clone for GameTree

fn clone(&self) -> GameTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GameTree

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

Formats the value using the given formatter.

impl Display for GameTree

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

Formats the value using the given formatter.

impl From<SgfNode<Prop>> for GameTree

fn from(sgf_node: SgfNode<Prop>) -> Self

Converts to this type from the input type.

impl From<SgfNode<Prop>> for GameTree

fn from(sgf_node: SgfNode<Prop>) -> Self

Converts to this type from the input type.

impl PartialEq for GameTree

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