Struct ReferenceRules 

#[non_exhaustive]
pub struct ReferenceRules {
    pub operators: OperatorSet,
    pub single_quotes: bool,
    pub escaped_dollar: bool,
    pub commands: bool,
    pub backtick_quotes: bool,
}

Caller-selected rules for deciding whether a raw candidate could expand.

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.

operators: OperatorSet

Variable forms and operators considered eligible.

single_quotes: bool

Whether references inside single-quoted values are eligible.

escaped_dollar: bool

Whether escaped-dollar candidates are eligible.

commands: bool

Whether $(command) candidates are eligible.

backtick_quotes: bool

Whether references inside backtick-quoted values are eligible.

Implementations

impl ReferenceRules

pub const fn with_operators(self, value: OperatorSet) -> Self

Use the given variable/operator eligibility set.

pub const fn with_single_quotes(self, value: bool) -> Self

Enable or disable references inside single quotes.

pub const fn with_escaped_dollar(self, value: bool) -> Self

Enable or disable escaped-dollar candidates.

pub const fn with_commands(self, value: bool) -> Self

Enable or disable command candidates.

pub const fn with_backtick_quotes(self, value: bool) -> Self

Enable or disable references inside backticks.

impl ReferenceRules

pub const NONE: Self

No references are eligible.

pub const PORTABLE: Self

Conservative Portable rules: basic variables only, no quotes or commands.

pub const COMPOSE: Self

Compose-style variable operators and nesting; no command execution.

pub const DOTENV_EXPAND: Self

dotenv-expand-style variables, single quotes and command substitution.

Trait Implementations

impl Clone for ReferenceRules

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReferenceRules

impl Debug for ReferenceRules

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

Formats the value using the given formatter.

impl Default for ReferenceRules

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ReferenceRules

impl Hash for ReferenceRules

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 ReferenceRules

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReferenceRules