Struct wca::Parser

pub struct Parser {
    pub command_prefix: char,
    pub prop_delimeter: char,
    pub namespace_delimeter: Cow<'static, str>,
}

Parser provides parsing command strings into ParsedCommand objects. It allows you to specify the symbols that will be used to interpret the command string, such as the command delimiter, property delimiter, and namespace delimiter.

use wca::{ Parser, CommandParser };
/// Configure the parser
let parser = Parser::former()
.command_prefix( '.' )
.prop_delimeter( ':' )
.form();

/// Parse a command from a` string
let raw_command = parser.command( ".command subject_value prop_name:prop_value" )?;

In the above example, a Parser object is created and configured to accept commands with a . prefix and : delimiters for properties.

Note that Parser uses CommandParser trait to parse commands from user input( You can also use NamespaceParser to parse namespaces, or ProgramParser to parse programs from string ).

Fields

command_prefix: char

Symbol that will be interpreted as the beginning of a command

command_delimiter = .

“.command” -> Command( “command” )

prop_delimeter: char

Symbol that will be interpreted as a separator for the name and value of the property

prop_delimiter = :

“prop:value” -> ( “prop”, “value” )

namespace_delimeter: Cow<'static, str>

String that will be interpreted as a separator for namespaces

namespace_delimiter = “.also”

“< commands1 > .also < commands2 >” -> Namespace( < commands1 > ), Namespace( < commands2 > )

Implementations

impl Parser

pub fn former() -> ParserFormer<Parser, ReturnContainer>

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

Trait Implementations

impl CommandParser for Parser

fn command<'a>(&'a self, input: &'a str) -> Result<Command>

Parses first command from string

impl CommandParserFn for Parser

fn command_fn(&self) -> Box<dyn Fn(&str) -> IResult<&str, ParsedCommand> + '_>

Returns function that can parse a Command

impl Debug for Parser

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

Formats the value using the given formatter.

impl ProgramParser for Parser

fn program<'a>(&'a self, input: &'a str) -> Result<Program<ParsedCommand>>

Parses program from string