Expand description
Defines the Abstract Syntax Tree (ast) for shell programs. Includes types and utilities for manipulating the AST.
Structs§
- AndOr
List - Represents a sequence of command pipelines connected by boolean operators.
- AndOr
List Iter - An iterator over the pipelines in an
AndOrList
. - Arithmetic
Command - An arithmetic command, evaluating an arithmetic expression.
- Arithmetic
ForClause Command - An arithmetic for clause, which loops until an arithmetic condition is reached.
- Assignment
- Encapsulates an assignment declaration.
- Brace
Group Command - A brace group, which groups commands together.
- Case
Clause Command - A case clause, which selects a command based on a value and a set of pattern-based filters.
- Case
Item - An individual matching case item in a case clause.
- Command
Prefix - Represents a prefix to a simple command.
- Command
Suffix - Represents a suffix to a simple command; a word argument, declaration, or I/O redirection.
- Compound
List - A sequence of commands.
- Compound
List Item - An element of a compound command list.
- DoGroup
Command - A do group, which groups commands together.
- Else
Clause - Represents the
else
clause of a conditional command. - ForClause
Command - A for clause, which loops over a set of values.
- Function
Body - Encapsulates the body of a function definition.
- Function
Definition - Encapsulates the definition of a shell function.
- IfClause
Command - An if clause, which conditionally executes a command.
- IoHere
Document - Represents an I/O here document.
- Pipeline
- A pipeline of commands, where each command’s output is passed as standard input to the command that follows it.
- Program
- Represents a complete shell program.
- Redirect
List - A list of I/O redirections to be applied to a command.
- Simple
Command - Represents the invocation of a simple command.
- Subshell
Command - A subshell, which executes commands in a subshell.
- Unexpanded
Arithmetic Expr - Encapsulates an unparsed arithmetic expression.
- While
OrUntil Clause Command - A while or until clause, whose looping is controlled by a condition.
- Word
- Represents a shell word.
Enums§
- AndOr
- Represents a boolean operator used to connect command pipelines, along with the succeeding pipeline.
- Arithmetic
Expr - An arithmetic expression.
- Arithmetic
Target - Identifies the target of an arithmetic assignment expression.
- Assignment
Name - The target of an assignment.
- Assignment
Value - A value being assigned to a variable.
- Binary
Operator - A binary arithmetic operator.
- Binary
Predicate - A binary predicate usable in an extended test expression.
- Case
Item Post Action - Describes the action to take after executing the body command of a case clause.
- Command
- Represents a shell command.
- Command
Prefix OrSuffix Item - A prefix or suffix for a simple command.
- Compound
Command - Represents a compound command, potentially made up of multiple nested commands.
- Extended
Test Expr - An extended test expression.
- IoFile
Redirect Kind - Kind of file I/O redirection.
- IoFile
Redirect Target - Target for an I/O file redirection.
- IoRedirect
- An I/O redirection.
- Pipeline
Operator - Represents a boolean operator used to connect command pipelines in an
AndOrList
- Pipeline
Timed - The type of timing requested for a pipeline.
- Process
Substitution Kind - Represents the I/O direction of a process substitution.
- Separator
Operator - Indicates whether the preceding command is executed synchronously or asynchronously.
- Test
Expr - A (non-extended) test expression.
- Unary
Assignment Operator - A unary arithmetic assignment operator.
- Unary
Operator - A unary arithmetic operator.
- Unary
Predicate - A unary predicate usable in an extended test expression.
Type Aliases§
- Complete
Command - Represents a complete shell command.
- Complete
Command Item - Represents a complete shell command item.