ChessTurnEngine

Struct ChessTurnEngine 

Source
pub struct ChessTurnEngine { /* private fields */ }
Expand description

Game engine

Implementations§

Source§

impl ChessTurnEngine

Source

pub fn new(setup: Setup) -> Result<ChessTurnEngine, &'static str>

Create and setup a new game

§Arguments
  • setup - Game setup
Source

pub fn display(&self, opt: DisplayOption) -> String

Provide a displayable String of the chessboard

§Arguments
  • opt - Display option
Source

pub fn display_on_screen(&self, opt: DisplayOption)

Display chessboard on the screen

§Arguments
  • opt - Display option
Source

pub fn play_turn(&mut self, turn: &str) -> Result<Gamestate, GameError>

Play provided turn.

§Return value
  • Ok - Latest game status.
  • Err - GameError in case turn is not playable.
§Arguments
  • turn - Turn provided in chess notation format
Source

pub fn gamestate(&self) -> Gamestate

Get game status

Source

pub fn undo_turn(&mut self) -> Result<(), GameError>

Undo turn and restore previous board state

Source

pub fn available_turns(&self) -> &Vec<AvailableTurn>

Get list of available turns

Auto Trait Implementations§

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<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.