Enum brush_parser::word::ParameterExpr

pub enum ParameterExpr {
    Parameter {
        parameter: Parameter,
        indirect: bool,
    },
    UseDefaultValues {
        parameter: Parameter,
        indirect: bool,
        test_type: ParameterTestType,
        default_value: Option<String>,
    },
    AssignDefaultValues {
        parameter: Parameter,
        indirect: bool,
        test_type: ParameterTestType,
        default_value: Option<String>,
    },
    IndicateErrorIfNullOrUnset {
        parameter: Parameter,
        indirect: bool,
        test_type: ParameterTestType,
        error_message: Option<String>,
    },
    UseAlternativeValue {
        parameter: Parameter,
        indirect: bool,
        test_type: ParameterTestType,
        alternative_value: Option<String>,
    },
    ParameterLength {
        parameter: Parameter,
        indirect: bool,
    },
    RemoveSmallestSuffixPattern {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    RemoveLargestSuffixPattern {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    RemoveSmallestPrefixPattern {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    RemoveLargestPrefixPattern {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    Substring {
        parameter: Parameter,
        indirect: bool,
        offset: UnexpandedArithmeticExpr,
        length: Option<UnexpandedArithmeticExpr>,
    },
    Transform {
        parameter: Parameter,
        indirect: bool,
        op: ParameterTransformOp,
    },
    UppercaseFirstChar {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    UppercasePattern {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    LowercaseFirstChar {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    LowercasePattern {
        parameter: Parameter,
        indirect: bool,
        pattern: Option<String>,
    },
    ReplaceSubstring {
        parameter: Parameter,
        indirect: bool,
        pattern: String,
        replacement: String,
        match_kind: SubstringMatchKind,
    },
    VariableNames {
        prefix: String,
        concatenate: bool,
    },
    MemberKeys {
        variable_name: String,
        concatenate: bool,
    },
}

A parameter expression, used in a parameter expansion.

Variants

Parameter

A parameter, with optional indirection.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

UseDefaultValues

Conditionally use default values.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

test_type: ParameterTestType

The type of test to perform.

default_value: Option<String>

Default value to conditionally use.

AssignDefaultValues

Conditionally assign default values.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

test_type: ParameterTestType

The type of test to perform.

default_value: Option<String>

Default value to conditionally assign.

IndicateErrorIfNullOrUnset

Indicate error if null or unset.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

test_type: ParameterTestType

The type of test to perform.

error_message: Option<String>

Error message to conditionally yield.

UseAlternativeValue

Conditionally use an alternative value.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

test_type: ParameterTestType

The type of test to perform.

alternative_value: Option<String>

Alternative value to conditionally use.

ParameterLength

Compute the length of the given parameter.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

RemoveSmallestSuffixPattern

Remove the smallest suffix from the given string matching the given pattern.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

RemoveLargestSuffixPattern

Remove the largest suffix from the given string matching the given pattern.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

RemoveSmallestPrefixPattern

Remove the smallest prefix from the given string matching the given pattern.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

RemoveLargestPrefixPattern

Remove the largest prefix from the given string matching the given pattern.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

Substring

Extract a substring from the given parameter.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

offset: UnexpandedArithmeticExpr

Arithmetic expression that will be expanded to compute the offset at which the substring should be extracted.

length: Option<UnexpandedArithmeticExpr>

Optionally provides an arithmetic expression that will be expanded to compute the length of substring to be extracted; if left unspecified, the remainder of the string will be extracted.

Transform

Transform the given parameter.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

op: ParameterTransformOp

Type of transformation to apply.

UppercaseFirstChar

Uppercase the first character of the given parameter.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

UppercasePattern

Uppercase the portion of the given parameter matching the given pattern.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

LowercaseFirstChar

Lowercase the first character of the given parameter.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

LowercasePattern

Lowercase the portion of the given parameter matching the given pattern.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: Option<String>

Optionally provides a pattern to match.

ReplaceSubstring

Replace occurrences of the given pattern in the given parameter.

Fields

parameter: Parameter

The parameter.

indirect: bool

Whether to treat the expanded parameter as an indirect reference, which should be subsequently dereferenced for the expansion.

pattern: String

Pattern to match.

replacement: String

Replacement string.

match_kind: SubstringMatchKind

Kind of match to perform.

VariableNames

Select variable names from the environment with a given prefix.

Fields

prefix: String

The prefix to match.

concatenate: bool

Whether to concatenate the results.

MemberKeys

Select member keys from the named array.

Fields

variable_name: String

Name of the array variable.

concatenate: bool

Whether to concatenate the results.

Trait Implementations

impl Debug for ParameterExpr

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

Formats the value using the given formatter.