Enum UciOptionConfig 

pub enum UciOptionConfig {
    Check {
        name: String,
        default: Option<bool>,
    },
    Spin {
        name: String,
        default: Option<i64>,
        min: Option<i64>,
        max: Option<i64>,
    },
    Combo {
        name: String,
        default: Option<String>,
        var: Vec<String>,
    },
    Button {
        name: String,
    },
    String {
        name: String,
        default: Option<String>,
    },
}

Represents a UCI option definition.

Variants

Check

The option of type check (a boolean).

Fields

name: String

The name of the option.

default: Option<bool>

The default value of this bool property.

Spin

The option of type spin (a signed integer).

Fields

name: String

The name of the option.

default: Option<i64>

The default value of this integer property.

min: Option<i64>

The minimal value of this integer property.

max: Option<i64>

The maximal value of this integer property.

Combo

The option of type combo (a list of strings).

Fields

name: String

The name of the option.

default: Option<String>

The default value for this list of strings.

var: Vec<String>

The list of acceptable strings.

Button

The option of type button (an action).

Fields

name: String

The name of the option.

String

The option of type string (a string, unsurprisingly).

Fields

name: String

The name of the option.

default: Option<String>

The default value of this string option.

Implementations

impl UciOptionConfig

pub fn get_name(&self) -> &str

Returns the name of the option.

pub fn get_type_str(&self) -> &'static str

Returns the type string of the option (ie. "check", "spin" …)

Trait Implementations

impl Clone for UciOptionConfig

fn clone(&self) -> UciOptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UciOptionConfig

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

Formats the value using the given formatter.

impl Display for UciOptionConfig

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

Formats the value using the given formatter.

impl Eq for UciOptionConfig

impl Hash for UciOptionConfig

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UciOptionConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serializable for UciOptionConfig

fn serialize(&self) -> String

Serializes this option config into a full UCI message string.

Examples

use vampirc_uci::{UciMessage, UciOptionConfig, Serializable};

let m = UciMessage::Option(UciOptionConfig::Check {
    name: String::from("Nullmove"),
    default: Some(true)
});

assert_eq!(m.serialize(), "option name Nullmove type check default true");

impl StructuralPartialEq for UciOptionConfig