Struct Parser 

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

Stateful parser for shell scripts.

Construct a parser with one of the Parser::with_* constructors and then call parse to obtain a super::ParseResult. The parser is single-use: parse consumes the value so internal recovery state cannot leak between parses.

Implementations

impl<'a> Parser<'a>

pub fn parse(self) -> ParseResult

Parse the configured input.

The returned ParseResult contains the best AST the parser could produce, plus recovery diagnostics and syntax facts. Use ParseResult::is_ok when a caller needs to reject recovered parses.

impl<'a> Parser<'a>

pub fn new(input: &'a str) -> Self

Create a new parser for the given input.

pub fn with_dialect(input: &'a str, dialect: ShellDialect) -> Self

Create a new parser for the given input and shell dialect.

This uses ShellProfile::native for the selected dialect. Use Parser::with_profile when zsh option state is known.

pub fn with_profile(input: &'a str, shell_profile: ShellProfile) -> Self

Create a new parser for the given input and full shell profile.

Profiles allow callers to provide parser-visible zsh option state in addition to the broad shell dialect.

pub fn with_max_depth(input: &'a str, max_depth: usize) -> Self

Create a new bash parser with a custom maximum AST depth.

The requested depth is clamped to the parser’s hard safety cap. Hitting the limit produces a non-clean ParseResult rather than panicking.

pub fn with_fuel(input: &'a str, max_fuel: usize) -> Self

Create a new bash parser with a custom fuel limit.

Fuel bounds the number of parser operations. Exhaustion produces a terminal parse error in the returned ParseResult.

pub fn with_limits(input: &'a str, max_depth: usize, max_fuel: usize) -> Self

Create a new bash parser with custom depth and fuel limits.

max_depth is clamped to the parser’s hard safety cap to prevent stack overflow from misconfiguration. max_fuel bounds parser operations. Either limit can produce a non-clean ParseResult.

pub fn with_limits_and_dialect( input: &'a str, max_depth: usize, max_fuel: usize, dialect: ShellDialect, ) -> Self

Create a new parser with custom depth, fuel, and dialect settings.

This uses ShellProfile::native for dialect; use Parser::with_limits_and_profile when explicit zsh option state is available.

pub fn with_limits_and_profile( input: &'a str, max_depth: usize, max_fuel: usize, shell_profile: ShellProfile, ) -> Self

Create a new parser with custom depth, fuel, and shell-profile settings.

This is the most explicit constructor for embedders that need both resource limits and parser-visible shell option state.

pub fn parse_word_string(input: &str) -> Word

Parse a standalone shell word string.

This handles shell word constructs such as parameter expansion, command substitution, arithmetic expansion, and quoting. The returned word is positioned as if input started at the beginning of a file.

pub fn parse_assignment_word_group( source: &str, words: &[&Word], explicit_array_kind: Option<ArrayKind>, subscript_interpretation: SubscriptInterpretation, ) -> Option<Assignment>

Classify a contiguous group of already-parsed words as a shell assignment.

Some shell syntax, such as process substitution inside an array subscript, can produce multiple AST words while still occupying one contiguous assignment operand in the source.

Trait Implementations

impl<'a> Clone for Parser<'a>

fn clone(&self) -> Parser<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.