Skip to main content

PositionMut

Struct PositionMut 

Source
pub struct PositionMut<'g> { /* private fields */ }
Expand description

A mutable reference to a position in a game.

Implementations§

Source§

impl<'g> PositionMut<'g>

Source

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

Source

pub fn into_push_uci(self, uci: Move) -> Result<MoveMut<'g>>

Source§

impl<'g> PositionMut<'g>

Options Mutation API

Source

pub fn push(&mut self, play: Move) -> Result<MoveMut<'_>>

Source

pub fn into_push(self, play: Move) -> Result<MoveMut<'g>>

Source

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

Source

pub fn into_option_or_push(self, play: Move) -> Result<MoveMut<'g>>

Source

pub fn insert_before( &mut self, option: impl Choose, play: Move, ) -> Result<MoveMut<'_>>

Source

pub fn into_insert_before( self, option: impl Choose, play: Move, ) -> Result<MoveMut<'g>>

Source

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

Source

pub fn into_option_or_insert_before( self, option: impl Choose, play: Move, ) -> Result<MoveMut<'g>>

Source

pub fn insert_after( &mut self, option: impl Choose, play: Move, ) -> Result<MoveMut<'_>>

Source

pub fn into_insert_after( self, option: impl Choose, play: Move, ) -> Result<MoveMut<'g>>

Source

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

Source

pub fn into_option_or_insert_after( self, option: impl Choose, play: Move, ) -> Result<MoveMut<'g>>

Source

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

Source

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

Source

pub fn into_remove_play(self) -> Result<PositionMut<'g>>

Source

pub fn swap(&mut self, a: impl Choose, b: impl Choose) -> Result<bool>

Source

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

Source

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

Source

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

Source

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

Source

pub fn drag(&mut self, from: impl Choose, to: impl Choose) -> Result<bool>

Source§

impl<'g> PositionMut<'g>

Access API.

Source

pub const fn slot(&self) -> PositionSlot

Source

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

Source

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

Source

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

Source

pub fn set_comment(&mut self, comment: Option<Text>)

Source

pub fn set_evaluation(&mut self, evaluation: Option<Evaluation>)

Source

pub fn set_expanded(&mut self, expanded: bool)

Source

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

Source§

impl<'g> PositionMut<'g>

Traversal API.

Source

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

Source

pub fn into_cursor_mut(self) -> CursorMut<'g>

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn option_mut(&mut self, option: impl Choose) -> Result<MoveMut<'_>>

Source

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

Source

pub fn alternatives_mut(&mut self) -> MovesMut<'_>

Source

pub fn into_alternatives(self) -> MovesMut<'g>

Source

pub fn iter_mut(&mut self) -> MovesMut<'_>

Source

pub fn into_iter_mut(self) -> MovesMut<'g>

Methods from Deref<Target = Position>§

Source

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

Source

pub fn position(&self) -> Position

Source

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

Source

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

Source

pub fn expanded(&self) -> bool

Source

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

Source

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

Source

pub fn is_terminal(&self) -> bool

Source

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

Source

pub fn is_checkmate(&self) -> bool

Source

pub fn is_stalemate(&self) -> bool

Methods from Deref<Target = Position>§

Source

pub fn apparent_fen(&self) -> String

Source

pub fn fen(&self) -> String

Source

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

Source

pub fn shredder_fen(&self) -> String

Source

pub fn transposition_fen(&self) -> String

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn is_terminal(&self) -> bool

Source

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

Source

pub fn board(&self) -> Board

Source

pub fn turn(&self) -> Player

Source

pub fn castles(&self) -> Castles

Source

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

Source

pub fn reversible(&self) -> u32

Source

pub fn round(&self) -> NonZeroU32

Source

pub fn requires_freestyle(&self) -> bool

Source

pub fn checkers(&self) -> Bitboard

Source

pub fn is_check(&self) -> bool

Source

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

Source

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

Source

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

Source

pub fn first_ply(&self) -> usize

Trait Implementations§

Source§

impl Deref for PositionMut<'_>

Source§

type Target = Position

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Position

Dereferences the value.

Auto Trait Implementations§

§

impl<'g> !UnwindSafe for PositionMut<'g>

§

impl<'g> Freeze for PositionMut<'g>

§

impl<'g> RefUnwindSafe for PositionMut<'g>

§

impl<'g> Send for PositionMut<'g>

§

impl<'g> Sync for PositionMut<'g>

§

impl<'g> Unpin for PositionMut<'g>

§

impl<'g> UnsafeUnpin for PositionMut<'g>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.