Trait async_uci::engine::ChessEngine

pub trait ChessEngine: Sized {
    // Required methods
    fn new<'life0, 'async_trait>(
        exe_path: &'life0 str
    ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn start_uci<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn new_game<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_position<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        position: &'life1 str
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn go_infinite<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn go_depth<'life0, 'async_trait>(
        &'life0 mut self,
        plies: usize
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn go_time<'life0, 'async_trait>(
        &'life0 mut self,
        ms: usize
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn go_mate<'life0, 'async_trait>(
        &'life0 mut self,
        mate_in: usize
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn stop<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_evaluation<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Option<Evaluation>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_options<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<Vec<EngineOption>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_option<'life0, 'async_trait>(
        &'life0 mut self,
        option: String,
        value: String
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

ChessEngine trait can be implemented for structures that implement the UCI Protocol

Required Methods

fn new<'life0, 'async_trait>( exe_path: &'life0 str ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Create new engine from executable

fn start_uci<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Start the UCI Protocol

fn new_game<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Notify engine of new game start

fn set_position<'life0, 'life1, 'async_trait>( &'life0 mut self, position: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Notify engine of new position to search

fn go_infinite<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Notify engine to search for best move until explicitly stopped

fn go_depth<'life0, 'async_trait>( &'life0 mut self, plies: usize ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Notify engine to search for best move to a certain depth

fn go_time<'life0, 'async_trait>( &'life0 mut self, ms: usize ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Notify engine to search for best move for a set time

fn go_mate<'life0, 'async_trait>( &'life0 mut self, mate_in: usize ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Notify engine to search for a mate in a certain number of moves

fn stop<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Notify engine to stop current search

fn get_evaluation<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Option<Evaluation>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Retrieve the latest evaluation from the engine

fn get_options<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<Vec<EngineOption>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Retrieve the list of available options from the engine

fn set_option<'life0, 'async_trait>( &'life0 mut self, option: String, value: String ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Set an option in the engine

Implementors

impl ChessEngine for Engine