Struct UciOption

pub struct UciOption<T = String> {
    pub name: T,
    pub opt_type: UciOptionType<T>,
}

Represents a UCI-compatible option that can be modified for your Engine.

Fields

name: T

Name of the option.

opt_type: UciOptionType<T>

What type of option it is.

Implementations

impl<T: Display> UciOption<T>

pub const fn new(name: T, opt_type: UciOptionType<T>) -> Self

Create a new UciOption with the provided name and type.

pub const fn check(name: T, default: bool) -> Self

Create a new UciOption of type UciOptionType::Check.

pub const fn spin(name: T, default: i32, min: i32, max: i32) -> Self

Create a new UciOption of type UciOptionType::Spin.

pub fn combo(name: T, default: T, vars: impl IntoIterator<Item = T>) -> Self

Create a new UciOption of type UciOptionType::Combo.

pub const fn button(name: T) -> Self

Create a new UciOption of type UciOptionType::Button.

pub const fn string(name: T, default: T) -> Self

Create a new UciOption of type UciOptionType::String.

Trait Implementations

impl<T: Clone> Clone for UciOption<T>

fn clone(&self) -> UciOption<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for UciOption<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for UciOption<T>

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

An option is displayed as name <name> type <type>.

impl<T: Hash> Hash for UciOption<T>

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<T: PartialEq> PartialEq for UciOption<T>

fn eq(&self, other: &UciOption<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for UciOption<T>

impl<T> StructuralPartialEq for UciOption<T>