Struct PositionRef 

pub struct PositionRef<'g> { /* private fields */ }

An immutable reference to a position in a game.

Implementations

impl PositionRef<'_>

pub fn uci_path(self) -> Vec<Move>

UCI moves from the game’s start position to this position.

pub fn resolve_uci(self, plays: &[Move]) -> Vec<Move>

pub fn resolve_uci_san(self, plays: &[Move]) -> Vec<San>

impl<'g> PositionRef<'g>

Access API.

pub const fn slot(&self) -> PositionSlot

pub const fn game(&self) -> &'g Game

pub fn into_game(self) -> Game

pub fn index(&self, option: impl Choose) -> Result<usize>

pub fn has_option(&self, option: impl Choose) -> bool

impl<'g> PositionRef<'g>

Traversal API.

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

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

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

pub fn option(&self, option: impl Choose) -> Result<MoveRef<'g>>

pub fn has_options(&self) -> bool

pub fn has_alternatives(&self) -> bool

pub fn alternatives(&self) -> Moves<'g>

pub fn iter(&self) -> Moves<'g>

Methods from Deref<Target = Position>

pub fn options(&self) -> &[MoveSlot]

pub fn position(&self) -> Position

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

pub fn evaluation(&self) -> Option<&Evaluation>

pub fn expanded(&self) -> bool

pub fn legal(&self) -> &[Move]

pub fn check(&self) -> Option<Check>

pub fn is_terminal(&self) -> bool

pub fn terminal(&self) -> Option<Terminal>

pub fn is_checkmate(&self) -> bool

pub fn is_stalemate(&self) -> bool

Methods from Deref<Target = Position>

pub fn apparent_fen(&self) -> String

pub fn fen(&self) -> String

pub fn chess_fen(&self) -> Option<String>

pub fn shredder_fen(&self) -> String

pub fn transposition_fen(&self) -> String

pub fn legal_plays(&self) -> Vec<Move>

pub fn legal_castle_plays(&self) -> Vec<Move>

pub fn pseudo_piece_plays(&self) -> Vec<Move>

pub fn legal_king_plays(&self) -> Vec<Move>

pub fn can_castle(&self, side: Side) -> Option<Move>

pub fn is_terminal(&self) -> bool

pub fn terminal(&self) -> Option<Terminal>

pub fn board(&self) -> Board

pub fn turn(&self) -> Player

pub fn castles(&self) -> Castles

pub fn en_passant(&self) -> Option<EnPassant>

pub fn reversible(&self) -> u32

pub fn round(&self) -> NonZeroU32

pub fn requires_freestyle(&self) -> bool

pub fn checkers(&self) -> Bitboard

pub fn is_check(&self) -> bool

pub fn capture_plays(&self) -> Vec<Move>

pub fn castle_side_plays(&self, side: Side) -> Vec<Move>

pub fn castle_plays(&self) -> Vec<Move>

pub fn first_ply(&self) -> usize

Trait Implementations

impl<'g> Clone for PositionRef<'g>

fn clone(&self) -> PositionRef<'g>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'g> Copy for PositionRef<'g>

impl Deref for PositionRef<'_>

type Target = Position

The resulting type after dereferencing.

fn deref(&self) -> &Position

Dereferences the value.

impl<'g> IntoIterator for PositionRef<'g>

type Item = MoveRef<'g>

The type of the elements being iterated over.

type IntoIter = Moves<'g>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.