Struct wca::GrammarConverter

pub struct GrammarConverter {
    pub commands: HashMap<String, Vec<Command>>,
}

Converts a RawCommand to a GrammarCommand by performing validation and type casting on values.

let grammar = GrammarConverter::former()
.command
(
  Command::former()
  .hint( "hint" )
  .long_hint( "long_hint" )
  .phrase( "command" )
  .form()
)
.form();

let raw_command = RawCommand
{
  name: "command".to_string(),
  subjects: vec![],
  properties: HashMap::new(),
};

let grammar_command = grammar.to_command( raw_command )?;

Fields

commands: HashMap<String, Vec<Command>>

all available commands

Implementations

impl GrammarConverter

pub fn former() -> GrammarConverterFormer

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

impl GrammarConverter

pub fn to_program( &self, raw_program: Program<Namespace<RawCommand>> ) -> Result<Program<Namespace<GrammarCommand>>>

Converts raw program to grammatically correct

Converts all namespaces into it with to_namespace method.

pub fn to_namespace( &self, raw_namespace: Namespace<RawCommand> ) -> Result<Namespace<GrammarCommand>>

Converts raw namespace to grammatically correct

Converts all commands into it with to_command method.

pub fn to_command(&self, raw_command: RawCommand) -> Result<GrammarCommand>

Converts raw command to grammatically correct

Make sure that this command is described in the grammar and matches it(command itself and all it options too).

Trait Implementations

impl Clone for GrammarConverter

fn clone(&self) -> GrammarConverter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrammarConverter

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

Formats the value using the given formatter.