Struct Game 

pub struct Game { /* private fields */ }

A game tree and its game-level data.

Implementations

impl Game

pub fn from_chessbase(encoded: Game) -> Result<Self>

impl Game

pub fn from_pgn(pgn: Pgn) -> Result<Self>

pub fn from_pgn_with(pgn: Pgn, import: &Import) -> Result<Self>

impl Game

pub fn undo(&mut self) -> Result<()>

pub fn restore(&mut self, revision: usize) -> Result<()>

pub fn patch(&mut self, patch: Patch) -> Result<()>

impl Game

pub fn play(&self, slot: MoveSlot) -> Result<MoveRef<'_>>

pub fn play_mut(&mut self, slot: MoveSlot) -> Result<MoveMut<'_>>

pub fn position(&self, slot: PositionSlot) -> Result<PositionRef<'_>>

pub fn position_mut(&mut self, slot: PositionSlot) -> Result<PositionMut<'_>>

pub const fn start(&self) -> PositionRef<'_>

pub const fn start_mut(&mut self) -> PositionMut<'_>

pub const fn into_cursor(self) -> Cursor

pub const fn cursor(&self) -> CursorRef<'_>

pub const fn cursor_mut(&mut self) -> CursorMut<'_>

pub const fn order(&self, slot: PositionSlot) -> Order<'_>

impl Game

pub fn merge(&mut self, other: &Game) -> Result<()>

Merges another game with the same starting position, retaining this game’s metadata.

impl Game

pub fn new(position: Position) -> Self

pub fn with_mode(position: Position, mode: Mode) -> Option<Self>

pub fn chess(position: Position) -> Option<Self>

pub fn freestyle(position: Position) -> Self

pub fn reslot(&mut self, layout: Layout) -> Reslot

Reassigns move slots in a prescribed layout and returns the old-to-new mapping.

Tracked changes are discarded, as they use the the old slots. Change tracking remains enabled or disabled as configured.

pub const fn mode(&self) -> Mode

pub const fn tracks_changes(&self) -> bool

pub fn track_changes(&mut self, on: bool)

pub fn changes(&self) -> Option<&[Change]>

pub fn revisions(&self) -> Option<usize>

pub fn clear_evaluations(&mut self)

pub const fn public(&self) -> &GamePublic

pub const fn title(&self) -> Option<&Text>

pub const fn orientation(&self) -> Player

pub const fn outcome(&self) -> Outcome

pub const fn roster(&self) -> &Roster

pub const fn tags(&self) -> &[Tag]

pub fn set_orientation(&mut self, orientation: Player)

pub fn set_title(&mut self, title: Option<Text>)

pub fn set_outcome(&mut self, outcome: Outcome)

pub fn update_roster(&mut self, update: impl FnOnce(&mut Roster))

pub fn update_tags(&mut self, update: impl FnOnce(&mut Vec<Tag>))

pub fn update_public(&mut self, update: impl FnOnce(&mut GamePublic))

impl Game

pub fn key(&self) -> Key

Trait Implementations

impl<'a> Arbitrary<'a> for Game

fn arbitrary(input: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Game

fn clone(&self) -> Game

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<Game> for Pgn

fn from(game: Game) -> Self

Converts to this type from the input type.

impl PartialEq for Game

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

impl TryFrom<Game> for Game

type Error = Error

The type returned in the event of a conversion error.

fn try_from(encoded: Game) -> Result<Self>

Performs the conversion.

impl TryFrom<Pgn> for Game

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pgn: Pgn) -> Result<Self>

Performs the conversion.