Struct Variable 

pub struct Variable { /* private fields */ }

One environment variable of an external command

A variable carries a name and a value. The command reads the variable in its environment, next to the variables that it inherits from the process that runs it. Some programs take a decision from a variable and from no flag, such as a test runner that selects the format of its report with one.

A pair of a name and a value becomes a variable, so a caller that holds its variables as pairs gives them to an invocation as they are.

Examples

use kawauso_process::invocation::Variable;

let variable = Variable::from(("RUSTUP_TOOLCHAIN", "stable"));

assert_eq!(variable.name().get(), "RUSTUP_TOOLCHAIN");

Implementations

impl Variable

pub fn new( name: impl Into<VariableName>, value: impl Into<VariableValue>, ) -> Self

Creates a variable from a name and a value

Examples

use kawauso_process::invocation::Variable;

let variable = Variable::new("CARGO_TERM_COLOR", "always");

assert_eq!(variable.value().get(), "always");

pub fn name(&self) -> &VariableName

Returns the name of the variable

pub fn value(&self) -> &VariableValue

Returns the value of the variable

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 Display for Variable

Shows the variable for a reader

The text is the name, an equals sign, and the value, which is the form in which a shell sets a variable. A value that holds a space shows without marks, because the caller that renders a whole command line adds the marks where the line needs them.

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

Formats the value using the given formatter.

impl Eq for Variable

impl<N: Into<VariableName>, V: Into<VariableValue>> From<(N, V)> for Variable

Creates a variable from a pair of a name and a value

fn from((name, value): (N, V)) -> Self

Converts to this type from the input type.

impl Hash for Variable

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 Ord for Variable

fn cmp(&self, other: &Variable) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Variable

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Variable

fn partial_cmp(&self, other: &Variable) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Variable