Struct Variable

pub struct Variable {
    pub name: String,
    pub options: Vec<String>,
    pub functions: Vec<VariableFunction>,
    pub secret: bool,
}

Represents a variable from a command

Fields

name: String

The variable name, as it was displayed on the command

options: Vec<String>

Parsed variable values derived from the name

functions: Vec<VariableFunction>

Parsed varable functions to apply

secret: bool

Whether the variable is secret

Implementations

impl Variable

pub fn parse(text: impl Into<String>) -> Self

Parses a variable into its components

pub fn env_var_names(&self, include_options: bool) -> HashSet<String>

Retrieves the env var names where the value for this variable might reside (in order of preference)

pub fn apply_functions_to(&self, text: impl Into<String>) -> String

Applies variable functions to the given text

pub fn check_functions_char(&self, ch: char) -> Option<String>

Iterates every function to check if a char has to be replaced

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

impl FromStr for Variable

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Variable

fn eq(&self, other: &Variable) -> 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 Variable

impl StructuralPartialEq for Variable