Struct VariableName 

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

The name of an environment variable of an external command

The value holds the name as the caller wrote it, and the crate checks nothing. The rules for a name differ between the platforms, and the operating system applies them when the command starts. A name that no program reads is therefore a valid name, and a name that the platform refuses, such as one that holds a NUL byte, fails when the command starts.

The value is an OsString, because the environment of a program holds the strings of the operating system and not the strings of Rust.

Examples

use kawauso_process::invocation::VariableName;

let name = VariableName::from("RUSTUP_TOOLCHAIN");

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

Implementations

impl VariableName

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

Creates a name from anything that becomes an OsString

Examples

use kawauso_process::invocation::VariableName;

let name = VariableName::new("CARGO_TERM_COLOR");

assert_eq!(name.get(), "CARGO_TERM_COLOR");

pub fn get(&self) -> &OsStr

Returns the name as the caller wrote it

Trait Implementations

impl Clone for VariableName

fn clone(&self) -> VariableName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VariableName

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

Formats the value using the given formatter.

impl Display for VariableName

Shows the name for a reader

A name 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 name.

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

Formats the value using the given formatter.

impl Eq for VariableName

impl From<&OsStr> for VariableName

Creates a name from a borrowed string of the operating system

fn from(name: &OsStr) -> Self

Converts to this type from the input type.

impl From<&str> for VariableName

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

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<OsString> for VariableName

Creates a name from a string of the operating system

fn from(name: OsString) -> Self

Converts to this type from the input type.

impl From<String> for VariableName

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

fn from(name: String) -> Self

Converts to this type from the input type.

impl Hash for VariableName

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 VariableName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VariableName

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