Struct SubstPayload 

#[non_exhaustive]
pub struct SubstPayload {
    pub segments: Vec<Segment>,
    pub optional: bool,
    pub list_suffix: bool,
}

Payload carried by a ${...} or ${?...} substitution token.

#[non_exhaustive] ensures that adding new fields here (e.g. future spec extensions) does not break downstream crates that pattern-match or construct this struct.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

segments: Vec<Segment>

optional: bool

list_suffix: bool

True when the substitution body carries a [] suffix, signalling env-var-list expansion (${X[]} / ${?X[]}).

Trait Implementations

impl Clone for SubstPayload

fn clone(&self) -> SubstPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubstPayload

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

Formats the value using the given formatter.