Enum vampirc_uci::uci::UciInfoAttribute

pub enum UciInfoAttribute {
    Depth(u8),
    SelDepth(u8),
    Time(u64),
    Nodes(u64),
    Pv(Vec<UciMove>),
    MultiPv(u16),
    Score {
        cp: Option<i32>,
        mate: Option<i8>,
        lower_bound: Option<bool>,
        upper_bound: Option<bool>,
    },
    CurrMove(UciMove),
    CurrMoveNum(u16),
    HashFull(u16),
    Nps(u64),
    TbHits(u64),
    SbHits(u64),
    CpuLoad(u16),
    String(String),
    Refutation(Vec<UciMove>),
    CurrLine {
        cpu_nr: Option<u16>,
        line: Vec<UciMove>,
    },
    Any(String, String),
}

The representation of various info messages. For an info attribute that is not listed in the protocol specification, the UciInfoAttribute::Any(name, value) variant can be used.

Variants

Depth(u8)

The info depth message.

SelDepth(u8)

The info seldepth message.

Time(u64)

The info time message.

Nodes(u64)

The info nodes message.

Pv(Vec<UciMove>)

The info pv message (best line move sequence).

MultiPv(u16)

The info pv ... multipv message (the pv line number in a multi pv sequence).

Score

The info score ... message.

Fields of Score

cp: Option<i32>

The score in centipawns.

mate: Option<i8>

Mate coming up in this many moves. Negative value means the engine is getting mated.

lower_bound: Option<bool>

The value sent is the lower bound.

upper_bound: Option<bool>

The value sent is the upper bound.

CurrMove(UciMove)

The info currmove message (current move).

CurrMoveNum(u16)

The info currmovenum message (current move number).

HashFull(u16)

The info hashfull message (the occupancy of hashing tables in permills).

Nps(u64)

The info nps message (nodes per second).

TbHits(u64)

The info tbhits message (end-game table-base hits).

SbHits(u64)

The info sbhits message (I guess some Shredder-specific end-game table-base stuff. I dunno, probably best to ignore).

CpuLoad(u16)

The info cpuload message (CPU load in permills).

String(String)

The info string message (a string the GUI should display).

Refutation(Vec<UciMove>)

The info refutation message (the first move is the move being refuted).

CurrLine

The info currline message (current line being calculated on a CPU).

Fields of CurrLine

cpu_nr: Option<u16>

The CPU number calculating this line.

line: Vec<UciMove>

The line being calculated.

Any(String, String)

Any other info line in the format (name, value).

Methods

impl UciInfoAttribute

pub fn from_centipawns(cp: i32) -> UciInfoAttribute

Creates a UciInfoAttribute::Score with the cp attribute set to the value of the parameter and all other fields set to None.

pub fn from_mate(mate: i8) -> UciInfoAttribute

Creates a UciInfoAttribute::Score with the mate attribute set to the value of the parameter and all other fields set to None. A negative value indicates it is the engine that is getting mated.

pub fn get_name(&self) -> &str

Returns the name of the info attribute.

Trait Implementations

impl Serializable for UciInfoAttribute

fn serialize(&self) -> String

Returns the attribute serialized as a String.

impl PartialEq<UciInfoAttribute> for UciInfoAttribute

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

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

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

This method tests for !=.

impl Clone for UciInfoAttribute

fn clone(&self) -> UciInfoAttribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for UciInfoAttribute

impl Display for UciInfoAttribute

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

Formats the value using the given formatter.

impl Debug for UciInfoAttribute

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

Formats the value using the given formatter.

impl Hash for UciInfoAttribute

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