Struct CommandParser

Source

pub struct CommandParser { /* private fields */ }

Expand description

A reusable parser with parse-time expansion context.

Implementations§

Source §

impl CommandParser

Source

pub fn new() -> Self

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

Source

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.

Source

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.

Source

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

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

Source

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

Adds the fallback home directory used for ~ expansion.

Source

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

Adds a deterministic ~user expansion mapping.

Source

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

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

Source

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.

Source

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.

Source

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

Overrides the maximum parsed command size.

Source

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

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

Source

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

Parses command structure without command-name lookup or alias expansion.

Source recovery uses this to find the command boundary around a lookup error without corrupting multi-line brace blocks.

Source

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

Parses source-file/startup config text with tmux source-file comment semantics.

tmux treats any unquoted # outside condition directives as the start of a comment, even when the next byte is {. Command strings parsed from argv or option values keep RMUX’s historical #{...} token support; only source-file text uses this stricter mode.

Source

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

Parses source-file structure without command-name lookup or alias expansion. Recovery uses this to locate command boundaries after a lookup error while preserving source-file comment semantics.

Source

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.

Source

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.

Source

pub fn parse_arguments_with_assignments<I, S>( &self, arguments: I, ) -> Result<ParsedCommands, CommandParseError>
where I: IntoIterator<Item = S>, S: AsRef<str>,

Parses an argv-style command vector for RMUX’s internal runtime bridge.

Unlike Self::parse_arguments, this recognizes one leading name=value assignment in each command group. The direct argv parser deliberately keeps tmux’s behavior; only the server-owned alias bridge opts into assignment classification.