Struct VariableValue 

pub struct VariableValue(/* private fields */);

The value of an environment variable of an external command

The value holds what the program reads, as the caller wrote it. Nothing splits it at a space or expands a character such as $, because no shell reads the command. A value that holds a space is one value.

The value is an OsString, because the environment of a program holds the strings of the operating system and not the strings of Rust. A value is often a path, such as the directory that a build tool writes to, and a path becomes a value without a conversion of its own.

Examples

use kawauso_process::invocation::VariableValue;

let value = VariableValue::from("-D warnings");

assert_eq!(value.get(), "-D warnings");

Implementations

impl VariableValue

pub fn new(value: impl Into<OsString>) -> Self

Creates a value from anything that becomes an OsString

Examples

use kawauso_process::invocation::VariableValue;

let value = VariableValue::new("always");

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

pub fn get(&self) -> &OsStr

Returns the value as the caller wrote it

Trait Implementations

impl Clone for VariableValue

fn clone(&self) -> VariableValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VariableValue

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

Formats the value using the given formatter.

impl Display for VariableValue

Shows the value for a reader

A value that is not valid UTF-8 shows the replacement character U+FFFD for each byte that has no character. The text is for a person, and no caller reads it back into a value.

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

Formats the value using the given formatter.

impl Eq for VariableValue

impl From<&OsStr> for VariableValue

Creates a value from a borrowed string of the operating system

fn from(value: &OsStr) -> Self

Converts to this type from the input type.

impl From<&Path> for VariableValue

Creates a value from a borrowed path, such as the root of a project

fn from(value: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for VariableValue

Creates a value from a borrowed string, such as a literal

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<OsString> for VariableValue

Creates a value from a string of the operating system

fn from(value: OsString) -> Self

Converts to this type from the input type.

impl From<PathBuf> for VariableValue

Creates a value from a path that the application built at runtime

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl From<String> for VariableValue

Creates a value from a string that the application built at runtime

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for VariableValue

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 VariableValue

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VariableValue

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