Struct EnvVariableValue 

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

Validated environment variable value.

Ensures the value contains no NUL bytes and does not exceed ENV_VARIABLE_VALUE_MAX_LEN bytes.

Implementations

impl EnvVariableValue

pub fn as_str(&self) -> &str

pub const fn from_static_or_panic(value: &'static str) -> Self

Validated environment variable value for 'static inputs.

Panics

Panics at compile time when used in a const context, or at runtime otherwise, if the value contains a NUL byte or exceeds ENV_VARIABLE_VALUE_MAX_LEN bytes.

Trait Implementations

impl AsRef<OsStr> for EnvVariableValue

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for EnvVariableValue

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EnvVariableValue

fn clone(&self) -> EnvVariableValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvVariableValue

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

Formats the value using the given formatter.

impl Display for EnvVariableValue

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

Formats the value using the given formatter.

impl From<&'static str> for EnvVariableValue

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl FromStr for EnvVariableValue

type Err = EnvVariableValueError

The associated error which can be returned from parsing.

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

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

impl Ord for EnvVariableValue

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

impl PartialEq for EnvVariableValue

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

fn partial_cmp(&self, other: &EnvVariableValue) -> 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 TryFrom<String> for EnvVariableValue

type Error = EnvVariableValueError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for EnvVariableValue

impl StructuralPartialEq for EnvVariableValue