Struct ConfigKey 

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

A validated single configuration key segment.

Implementations

impl ConfigKey

pub fn new(input: impl AsRef<str>) -> Result<ConfigKey, ConfigKeyError>

Creates a configuration key from one non-empty segment.

Errors

Returns ConfigKeyError when the input is empty after trimming or contains a dot.

pub fn as_str(&self) -> &str

Returns the key as a borrowed string slice.

pub fn into_string(self) -> String

Returns the owned key string.

Trait Implementations

impl Clone for ConfigKey

fn clone(&self) -> ConfigKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigKey

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

Formats the value using the given formatter.

impl Display for ConfigKey

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

Formats the value using the given formatter.

impl From<ConfigKey> for ConfigPath

fn from(key: ConfigKey) -> ConfigPath

Converts to this type from the input type.

impl FromStr for ConfigKey

type Err = ConfigKeyError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<ConfigKey, <ConfigKey as FromStr>::Err>

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

impl Hash for ConfigKey

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 ConfigKey

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

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

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

impl StructuralPartialEq for ConfigKey