Struct UciOption

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

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

Fields

name: T

Name of the option.

opt_type: UciOptionType<INT>

What type of option it is.

Implementations

impl<T, INT> UciOption<T, INT>

pub fn new(name: impl Into<T>, opt_type: UciOptionType<INT>) -> Self

Create a new UciOption with the provided name and type.

pub fn check(name: impl Into<T>, default: impl Into<bool>) -> Self

Create a new UciOption of type UciOptionType::Check.

pub fn spin( name: impl Into<T>, default: impl Into<INT>, min: impl Into<INT>, max: impl Into<INT>, ) -> Self

Create a new UciOption of type UciOptionType::Spin.

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

Create a new UciOption of type UciOptionType::Combo.

pub fn button(name: impl Into<T>) -> Self

Create a new UciOption of type UciOptionType::Button.

pub fn string(name: impl Into<T>, default: impl Display) -> Self

Create a new UciOption of type UciOptionType::String.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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, INT: Hash> Hash for UciOption<T, INT>

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

fn eq(&self, other: &UciOption<T, INT>) -> 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, INT: Eq> Eq for UciOption<T, INT>

impl<T, INT> StructuralPartialEq for UciOption<T, INT>