Struct ConfigPath 

pub struct ConfigPath { /* private fields */ }

A validated dotted configuration path.

Implementations

impl ConfigPath

pub fn parse(input: &str) -> Result<ConfigPath, ConfigKeyError>

Parses a dotted configuration path.

Errors

Returns ConfigKeyError when the path is empty or contains an invalid segment.

pub fn from_segments<I, S>(segments: I) -> Result<ConfigPath, ConfigKeyError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Creates a path from already separated segments.

Errors

Returns ConfigKeyError when no segments are provided or any segment is invalid.

pub const fn len(&self) -> usize

Returns the number of path segments.

pub const fn is_empty(&self) -> bool

Returns true when the path has no segments.

pub fn segments(&self) -> impl Iterator<Item = &str>

Iterates over path segments in deterministic order.

pub fn get(&self, index: usize) -> Option<&str>

Returns a path segment by index.

pub fn first(&self) -> Option<&str>

Returns the first path segment.

pub fn last(&self) -> Option<&str>

Returns the final path segment.

Trait Implementations

impl Clone for ConfigPath

fn clone(&self) -> ConfigPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigPath

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

Formats the value using the given formatter.

impl Display for ConfigPath

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 ConfigPath

type Err = ConfigKeyError

The associated error which can be returned from parsing.

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

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

impl Hash for ConfigPath

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 ConfigPath

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

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

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

impl StructuralPartialEq for ConfigPath