Struct EnvVarName 

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

One environment variable name a scope declares its runs may inherit.

A String would put the judgement in whichever caller remembered it. This has one constructor, and that constructor is reached where a configuration file is read — which is the only moment the refusal is still worth anything, because a name handed to a child process is a name the child cannot be asked to forget.

Implementations

impl EnvVarName

pub fn parse(raw: &str) -> Result<EnvVarName, AxError>

Sole constructor.

Errors

Refuses an empty name, a name carrying the = that separates a name from a value, a name carrying a control character, and a name crate::secret::names_a_credential reads as a credential.

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for EnvVarName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvVarName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvVarName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EnvVarName

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

Formats the value using the given formatter.

impl Eq for EnvVarName

impl From<EnvVarName> for String

fn from(name: EnvVarName) -> String

Converts to this type from the input type.

impl Ord for EnvVarName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EnvVarName

fn partial_cmp(&self, other: &Self) -> 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 Serialize for EnvVarName

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EnvVarName

impl TryFrom<String> for EnvVarName

type Error = AxError

The type returned in the event of a conversion error.

fn try_from(raw: String) -> Result<EnvVarName, AxError>

Performs the conversion.