Struct ConfigNamePathBuf

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

Dotted config name path.

Implementations

impl ConfigNamePathBuf

pub fn root() -> Self

Creates an empty path pointing to the root table.

This isn’t a valid TOML key expression, but provided for convenience.

pub fn is_root(&self) -> bool

Returns true if the path is empty (i.e. pointing to the root table.)

pub fn components(&self) -> Iter<'_, Key>

Returns iterator of path components (or keys.)

pub fn push(&mut self, key: impl Into<Key>)

Appends the given key component.

pub fn lookup_value(&self, config: &Config) -> Result<Value, ConfigError>

Looks up value in the given config.

This is a workaround for the config.get() API, which doesn’t support literal path expression. If we implement our own config abstraction, this method should be moved there.

Trait Implementations

impl AsRef<[Key]> for ConfigNamePathBuf

fn as_ref(&self) -> &[Key]

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

impl Clone for ConfigNamePathBuf

fn clone(&self) -> ConfigNamePathBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigNamePathBuf

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

Formats the value using the given formatter.

impl Display for ConfigNamePathBuf

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

Formats the value using the given formatter.

impl<K: Into<Key>> FromIterator<K> for ConfigNamePathBuf

fn from_iter<I: IntoIterator<Item = K>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for ConfigNamePathBuf

type Err = TomlError

The associated error which can be returned from parsing.

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

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

impl Hash for ConfigNamePathBuf

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 ConfigNamePathBuf

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

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

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

impl StructuralPartialEq for ConfigNamePathBuf