Struct wca::Command

pub struct Command {
    pub hint: String,
    pub long_hint: String,
    pub phrase: String,
    pub subjects: Vec<ValueDescription>,
    pub properties: HashMap<String, ValueDescription>,
    pub properties_aliases: HashMap<String, String>,
}

Command descriptor.

Based on this structure, the structure( ParsedCommand ) obtained after parsing will be validated and converted to VerifiedCommand.

Example:

let command = Command::former()
.hint( "hint" )
.long_hint( "long_hint" )
.phrase( "command" )
.subject( "subject", Type::String, false )
.form();

Fields

hint: String

Command common hint.

long_hint: String

Command full hint.

phrase: String

Phrase descriptor for command.

subjects: Vec<ValueDescription>

Command subjects hints and types.

properties: HashMap<String, ValueDescription>

Hints and types for command options.

properties_aliases: HashMap<String, String>

Map of aliases.

Implementations

impl Command

pub fn former() -> CommandFormer

Make former, variation of builder pattern to form structure defining values of fields step by step.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl PartialEq for Command

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

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

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

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

impl Eq for Command

impl StructuralPartialEq for Command