Struct CommandParser 

pub struct CommandParser { /* private fields */ }

A reusable parser with parse-time expansion context.

Implementations

impl CommandParser

pub fn new() -> Self

Creates a parser with no environment, tilde, or user alias overrides.

pub fn with_environment_value( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Adds one variable to the parse-time environment expansion context.

pub fn with_format_value( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Adds one parse-time format variable used by %if condition expansion.

pub fn with_environment_store(self, environment: &EnvironmentStore) -> Self

Copies global values from an RMUX environment store into the parser.

pub fn with_home_dir(self, home_dir: impl Into<String>) -> Self

Adds the fallback home directory used for ~ expansion.

pub fn with_user_home_dir( self, user: impl Into<String>, home_dir: impl Into<String>, ) -> Self

Adds a deterministic ~user expansion mapping.

pub fn with_command_alias( self, definition: impl Into<String>, ) -> Result<Self, CommandParseError>

Adds one command-alias option entry of the form name=value.

pub fn with_command_aliases<I, S>(self, definitions: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the parser alias table with valid command-alias entries.

pub fn with_exact_commands(self, commands: &'static [CommandEntry]) -> Self

Adds exact-only command names to this parser.

These entries are intentionally excluded from tmux-style prefix lookup. Use this for client-side RMUX extensions; server-side source-file parsing should keep the frozen tmux command table.

pub fn with_max_command_bytes(self, max_command_bytes: usize) -> Self

Overrides the maximum parsed command size.

pub fn parse(&self, input: &str) -> Result<ParsedCommands, CommandParseError>

Parses a tmux command string through the tmux-style lexer.

pub fn parse_one_group( &self, input: &str, ) -> Result<ParsedCommands, CommandParseError>

Parses a tmux command string with CMD_PARSE_ONEGROUP semantics.

tmux uses this mode when a command string is parsed from an argument or option value, so embedded newlines do not create independent abort groups.

pub fn parse_arguments<I, S>( &self, arguments: I, ) -> Result<ParsedCommands, CommandParseError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Parses an argv-style tmux command vector.

tmux treats these arguments as already split and only divides commands on unescaped trailing semicolons.

Trait Implementations

impl Clone for CommandParser

fn clone(&self) -> CommandParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandParser

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

Formats the value using the given formatter.

impl Default for CommandParser

fn default() -> Self

Returns the “default value” for a type.