Struct wca::CommandsAggregator

pub struct CommandsAggregator { /* private fields */ }

The CommandsAggregator struct is responsible for aggregating all commands that the user defines, and for parsing and executing them. It is the main entry point of the library.

CommandsAggregator component brings everything together. This component is responsible for configuring the Parser, Grammar, and Executor components based on the user’s needs. It also manages the entire pipeline of processing, from parsing the raw text input to executing the final command(parse -> validate -> execute).

Example:

use wca::prelude::*;

let ca = CommandsAggregator::former()
.grammar(
[
  Command::former()
  .phrase( "echo" )
  .hint( "prints all subjects and properties" )
  .subject( "Subject", Type::String, false )
  .property( "property", "simple property", Type::String, false )
  .form(),
])
.executor(
[
  ( "echo".to_owned(), Routine::new( |( args, props )|
  {
    println!( "= Args\n{args:?}\n\n= Properties\n{props:?}\n" );
    Ok( () )
  })),
])
.build();

ca.perform( ".echo something" )?;

Implementations

impl CommandsAggregator

pub fn former() -> CommandsAggregatorFormer

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

impl CommandsAggregator

pub fn perform<S>(&self, program: S) -> Result<(), Error>

where S: AsRef<str>,

Parse, converts and executes a program

Takes a string with program and executes it

Trait Implementations

impl Debug for CommandsAggregator

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

Formats the value using the given formatter.