Struct ConfigKey

Source
pub struct ConfigKey(/* private fields */);
Expand description

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

Implementations§

Source§

impl ConfigKey

Source

pub fn empty() -> Self

Get an empty config key.

Source

pub fn is_empty(&self) -> bool

Source

pub fn len(&self) -> usize

Key length.

Source

pub fn separator() -> &'static str

Configuration key seperator.

Source

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");
Source

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");
Source

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");
Source

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");
Source

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§

Source§

impl AsRef<str> for ConfigKey

Source§

fn as_ref(&self) -> &str

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

impl Clone for ConfigKey

Source§

fn clone(&self) -> ConfigKey

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfigKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ConfigKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&ConfigKey> for ConfigKey

Source§

fn from(value: &ConfigKey) -> Self

Converts to this type from the input type.
Source§

impl From<&String> for ConfigKey

Source§

fn from(value: &String) -> Self

Converts to this type from the input type.
Source§

impl From<&str> for ConfigKey

Source§

fn from(value: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for ConfigKey

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl Hash for ConfigKey

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Into<String> for ConfigKey

Source§

fn into(self) -> String

Converts this type into the (usually inferred) input type.
Source§

impl PartialEq<&String> for ConfigKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<&str> for ConfigKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<String> for ConfigKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<str> for ConfigKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq for ConfigKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ConfigKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,