Struct Config

pub struct Config<'a> { /* private fields */ }

Set of parameters for constructing a parser

Config is a builder for constructing a parser. A new configuration starts with default settings. You can customize them by calling methods that can be chained. Finally, you can create a parser by providing the lexer to the input method.

Implementations

impl<'a> Config<'a>

pub fn new() -> Self

Creates a new configuration with default settings.

You can also call Parser::config to create a new configuration.

pub fn aliases(&mut self, aliases: &'a dyn Glossary) -> &mut Self

Sets the glossary of aliases.

The parser uses the glossary to look up aliases and substitute command words. The default glossary is empty.

pub fn declaration_utilities( &mut self, decl_utils: &'a dyn Glossary, ) -> &mut Self

Sets the glossary of declaration utilities.

The parser uses the glossary to determine whether a command name is a declaration utility. The default glossary is PosixGlossary, which recognizes the declaration utilities defined by POSIX. You can make arbitrary command names declaration utilities by providing a custom glossary. To meet the POSIX standard, the glossary’s is_declaration_utility method must return:

• Some(true) for export and readonly
• None for command

For detailed information on declaration utilities, see the decl_utils module.

pub fn input<'b>(&self, lexer: &'a mut Lexer<'b>) -> Parser<'a, 'b>

Creates a parser with the given lexer.

Trait Implementations

impl<'a> Debug for Config<'a>

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

Formats the value using the given formatter.

impl Default for Config<'_>

fn default() -> Self

Returns the “default value” for a type.