Enum vampirc_uci::uci::UciMessage

pub enum UciMessage {
    Uci,
    Debug(bool),
    IsReady,
    Register {
        later: bool,
        name: Option<String>,
        code: Option<String>,
    },
    Position {
        startpos: bool,
        fen: Option<UciFen>,
        moves: Vec<UciMove>,
    },
    SetOption {
        name: String,
        value: Option<String>,
    },
    UciNewGame,
    Stop,
    PonderHit,
    Quit,
    Go {
        time_control: Option<UciTimeControl>,
        search_control: Option<UciSearchControl>,
    },
    Id {
        name: Option<String>,
        author: Option<String>,
    },
    UciOk,
    ReadyOk,
    BestMove {
        best_move: UciMove,
        ponder: Option<UciMove>,
    },
    CopyProtection(ProtectionState),
    Registration(ProtectionState),
    Option(UciOptionConfig),
    Info(Vec<UciInfoAttribute>),
    Unknown(String, Option<PestError<Rule>>),
}

An enumeration type containing representations for all messages supported by the UCI protocol.

Variants

Uci

The uci engine-bound message.

Debug(bool)

The debug engine-bound message. Its internal property specifies whether debug mode should be enabled (true), or disabled (false).

IsReady

The isready engine-bound message.

Register

The register engine-bound message.

Fields of Register

later: bool

The register later engine-bound message.

name: Option<String>

The name part of the register <code> <name> engine-bound message.

code: Option<String>

The code part of the register <code> <name> engine-bound message.

Position

The position engine-bound message.

Fields of Position

startpos: bool

If true, it denotes the starting chess position. Generally, if this property is true, then the value of the fen property will be None.

fen: Option<UciFen>

The FEN format representation of a chess position.

moves: Vec<UciMove>

A list of moves to apply to the position.

SetOption

The setoption engine-bound message.

Fields of SetOption

name: String

The name of the option to set.

value: Option<String>

The value of the option to set. If the option has no value, this should be None.

UciNewGame

The ucinewgame engine-bound message.

Stop

The stop engine-bound message.

PonderHit

The ponderhit engine-bound message.

Quit

The quit engine-bound message.

Go

The go engine-bound message.

Fields of Go

time_control: Option<UciTimeControl>

Time-control-related go parameters (sub-commands).

search_control: Option<UciSearchControl>

Search-related go parameters (sub-commands).

Id

The id GUI-bound message.

Fields of Id

name: Option<String>

The name of the engine, possibly including the version.

author: Option<String>

The name of the author of the engine.

UciOk

The uciok GUI-bound message.

ReadyOk

The readyok GUI-bound message.

BestMove

The bestmove GUI-bound message.

Fields of BestMove

best_move: UciMove

The move the engine thinks is the best one in the position.

ponder: Option<UciMove>

The move the engine would like to ponder on.

CopyProtection(ProtectionState)

The copyprotection GUI-bound message.

Registration(ProtectionState)

The registration GUI-bound message.

Option(UciOptionConfig)

The option GUI-bound message.

Info(Vec<UciInfoAttribute>)

The info GUI-bound message.

Unknown(String, Option<PestError<Rule>>)

Indicating unknown message.

Implementations

impl UciMessage

pub fn register_later() -> UciMessage

Constructs a register later UciMessage::Register message.

pub fn register_code(name: &str, code: &str) -> UciMessage

Constructs a register <code> <name> UciMessage::Register message.

pub fn go() -> UciMessage

Constructs an empty UciMessage::Register message.

pub fn go_ponder() -> UciMessage

Construct a go ponder UciMessage::Register message.

pub fn go_infinite() -> UciMessage

Constructs a go infinite UciMessage::Register message.

pub fn go_movetime(milliseconds: Duration) -> UciMessage

Constructs a go movetime <milliseconds> UciMessage::Register message, with milliseconds as the argument.

pub fn id_name(name: &str) -> UciMessage

Constructs an id <name> GUI-bound message.

pub fn id_author(author: &str) -> UciMessage

Constructs an id <name> GUI-bound message.

pub fn best_move(best_move: UciMove) -> UciMessage

Constructs a bestmove GUI-bound message without the ponder move.

pub fn best_move_with_ponder(best_move: UciMove, ponder: UciMove) -> UciMessage

Constructs a bestmove GUI-bound message with the ponder move.

pub fn info_string(s: String) -> UciMessage

Constructs an info string ... message.

pub fn direction(&self) -> CommunicationDirection

Returns whether the command was meant for the engine or for the GUI.

pub fn as_bool(&self) -> Option<bool>

If this UciMessage is a UciMessage::SetOption and the value of that option is a bool, this method returns the bool value, otherwise it returns None.

pub fn as_i32(&self) -> Option<i32>

If this UciMessage is a UciMessage::SetOption and the value of that option is an integer, this method returns the i32 value of the integer, otherwise it returns None.

pub fn is_unknown(&self) -> bool

Return true if this UciMessage is of variant UnknownMessage.

Trait Implementations

impl AsRef<UciMessage> for ByteVecUciMessage

fn as_ref(&self) -> &UciMessage

Performs the conversion.

impl Clone for UciMessage

fn clone(&self) -> UciMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UciMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for UciMessage

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl Eq for UciMessage

impl From<UciMessage> for ByteVecUciMessage

fn from(m: UciMessage) -> Self

Performs the conversion.

impl Hash for UciMessage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Into<UciMessage> for ByteVecUciMessage

fn into(self) -> UciMessage

Performs the conversion.

impl PartialEq<UciMessage> for UciMessage

fn eq(&self, other: &UciMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UciMessage) -> bool

This method tests for !=.

impl Serializable for UciMessage

fn serialize(&self) -> String

Serializes the command into a String.

Examples

use vampirc_uci::{UciMessage, Serializable};

println!("{}", UciMessage::Uci.serialize()); // Should print `uci`.

impl StructuralEq for UciMessage

impl StructuralPartialEq for UciMessage