Struct Cursor 

pub struct Cursor<G = Game> { /* private fields */ }

A movable position within a game tree.

Implementations

impl<G: BorrowMut<Game>> Cursor<G>

pub fn push_uci(&mut self, uci: Move) -> Result<MoveRef<'_>>

impl Cursor<Game>

Access API.

pub const fn new(game: Game) -> Self

pub fn into_game(self) -> Game

impl<G> Cursor<G>

Access API.

pub const fn slot(&self) -> PositionSlot

impl<G: Borrow<Game>> Cursor<G>

Access API.

pub fn game(&self) -> &Game

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

pub fn play(&self) -> Result<MoveRef<'_>>

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

impl<G: BorrowMut<Game>> Cursor<G>

Access API.

pub fn game_mut(&mut self) -> &mut Game

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

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 cursor_mut(&mut self) -> CursorMut<'_>

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

pub fn play_mut(&mut self) -> Result<MoveMut<'_>>

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

impl<'g> Cursor<&'g Game>

Access API.

pub fn into_game(self) -> &'g Game

pub fn into_position(self) -> PositionRef<'g>

pub fn into_play(self) -> Result<MoveRef<'g>>

impl<'g> Cursor<&'g mut Game>

Access API.

pub fn into_position_mut(self) -> PositionMut<'g>

pub fn into_play_mut(self) -> Result<MoveMut<'g>>

impl<G: Borrow<Game>> Cursor<G>

Traversal API.

pub fn set(&mut self, slot: PositionSlot) -> Result<bool>

pub fn prev(&mut self) -> Result<PositionSlot>

pub fn mainline_end(&mut self) -> PositionSlot

pub fn main(&mut self) -> Result<PositionSlot>

pub fn option(&mut self, option: impl Choose) -> Result<PositionSlot>

impl<G: BorrowMut<Game>> Cursor<G>

Options Mutation API

pub fn option_mut_or_push(&mut self, play: Move) -> Result<PositionSlot>

pub fn option_mut_or_insert_before( &mut self, option: impl Choose, play: Move, ) -> Result<PositionSlot>

pub fn option_mut_or_insert_after( &mut self, option: impl Choose, play: Move, ) -> Result<PositionSlot>

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

Unlike self.position_mut().into_remove_play(), this first retreats the cursor so its former position is no longer protected by the cursor itself.

Methods from Deref<Target = Game>

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

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

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

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

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

pub fn mode(&self) -> Mode

pub fn tracks_changes(&self) -> bool

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

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

pub fn public(&self) -> &GamePublic

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

pub fn orientation(&self) -> Player

pub fn outcome(&self) -> Outcome

pub fn roster(&self) -> &Roster

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

pub fn key(&self) -> Key

Trait Implementations

impl<G: Clone> Clone for Cursor<G>

fn clone(&self) -> Cursor<G>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G: Borrow<Game>> Deref for Cursor<G>

type Target = Game

The resulting type after dereferencing.

fn deref(&self) -> &Game

Dereferences the value.

impl<G: PartialEq> PartialEq for Cursor<G>

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