Struct Param

pub struct Param {
    pub id: String,
    pub type: ParamType,
}

Parameter

A parameter is an identifier that appears in a parameter expansion (TextUnit::RawParam and BracedParam). There are three types of parameters depending on the character category of the identifier.

Fields

id: String

Literal representation of the parameter name

This is the raw string form of the parameter as it appears in the source code. Examples include foo, @, #, 0, and 12.

type: ParamType

Type of the parameter

This precomputed value is used to optimize the evaluation of parameter expansions by avoiding the need to parse the id field every time.

It is your responsibility to ensure that the type field is consistent with the id field. For example, if the id field is "@", the type field must be Special(At). The parser ensures this invariant when it constructs a Param value.

Implementations

impl Param

pub fn variable<I: Into<String>>(id: I) -> Param

Constructs a Param value representing a named parameter.

This function assumes that the argument is a valid name for a variable. The returned Param value will have the Variable type regardless of the argument.

Trait Implementations

impl Clone for Param

fn clone(&self) -> Param

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Param

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

Formats the value using the given formatter.

impl Display for Param

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

Formats the value using the given formatter.

impl From<SpecialParam> for Param

Constructs a Param value representing a special parameter.

fn from(special: SpecialParam) -> Param

Converts to this type from the input type.

impl From<usize> for Param

Constructs a Param value from a positional parameter index.

fn from(index: usize) -> Param

Converts to this type from the input type.

impl Hash for Param

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Param

fn eq(&self, other: &Param) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Param

impl StructuralPartialEq for Param