Struct preftool::ConfigKey

pub struct ConfigKey(_);

Represents a configuration key. Configuration keys are case-insensitive, and all instances are lower-cased.

Methods

impl ConfigKey

pub fn empty() -> Self

Get an empty config key.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Key length.

pub fn separator() -> &'static str

Configuration key seperator.

pub fn section_key(&self) -> Self

Get the section key given a config path.

Arguments

• path - configuration path.

Example

use preftool::ConfigKey;
assert_eq!(ConfigKey::from("").section_key(), "");
assert_eq!(ConfigKey::from("foo").section_key(), "foo");
assert_eq!(ConfigKey::from("foo:bar").section_key(), "bar");
assert_eq!(ConfigKey::from("foo:bar:baz").section_key(), "baz");

pub fn parent(&self) -> Self

Get the parent config path.

Arguments

• path - configuration path.

Example

use preftool::ConfigKey;
assert_eq!(ConfigKey::from("").parent(), "");
assert_eq!(ConfigKey::from("foo").parent(), "");
assert_eq!(ConfigKey::from("foo:bar").parent(), "foo");
assert_eq!(ConfigKey::from("foo:bar:baz").parent(), "foo:bar");

pub fn combine<S2: Into<ConfigKey>>(&self, key: S2) -> Self

Combine two config path segments.

Arguments

• path - configuration path.
• key - configuration sub-key.

Example

use preftool::ConfigKey;
assert_eq!(ConfigKey::from("").combine(""), "");
assert_eq!(ConfigKey::from("").combine("foo"), "foo");
assert_eq!(ConfigKey::from("foo:bar").combine("baz"), "foo:bar:baz");
assert_eq!(ConfigKey::from("foo").combine("bar:baz"), "foo:bar:baz");

pub fn join<S: Into<ConfigKey>, I: IntoIterator<Item = S>>(parts: I) -> Self

Join a list of path segments into one config path.

Arguments

• paths - configuration path segments.

Example

use preftool::ConfigKey;
assert_eq!(ConfigKey::join::<&'static str, Vec<_>>(vec!()), "");
assert_eq!(ConfigKey::join(vec!("foo")), "foo");
assert_eq!(ConfigKey::join(vec!("", "foo", "")), "foo");
assert_eq!(ConfigKey::join(vec!("", "foo:bar", "", "baz")), "foo:bar:baz");

pub fn unsafe_from<S: Into<String>>(value: S) -> Self

Construct a config key from a string. This does not do any validation/lowercasing of the string, and should only be used if the string is guaranteed to be safe. This method is typically used by derive implementations.

Arguments

• value - string value.

Example

use preftool::ConfigKey;
assert_eq!(ConfigKey::unsafe_from("foo:bar"), "foo:bar");

Trait Implementations

impl AsRef<str> for ConfigKey

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for ConfigKey

fn clone(&self) -> ConfigKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> From<&'_ str> for ConfigKey

fn from(value: &str) -> Self

Performs the conversion.

impl<'_> From<&'_ String> for ConfigKey

fn from(value: &String) -> Self

Performs the conversion.

impl From<String> for ConfigKey

fn from(value: String) -> Self

Performs the conversion.

impl<'_> From<&'_ ConfigKey> for ConfigKey

fn from(value: &ConfigKey) -> Self

Performs the conversion.

impl Eq for ConfigKey

impl Into<String> for ConfigKey

fn into(self) -> String

Performs the conversion.

impl PartialEq<ConfigKey> for ConfigKey

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialEq<String> for ConfigKey

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialEq<str> for ConfigKey

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<'_> PartialEq<&'_ String> for ConfigKey

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<'_> PartialEq<&'_ str> for ConfigKey

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Debug for ConfigKey

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

Formats the value using the given formatter.

impl Display for ConfigKey

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

Formats the value using the given formatter.

impl Hash for ConfigKey

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].