Struct Key 

pub struct Key { /* private fields */ }

A configuration key path.

Keys represent paths to values in configuration files using a dot-separated notation with support for array indices and attributes.

Examples

use bare_config::key::Key;
use std::str::FromStr;

let key = Key::from_str(".database.host").unwrap();
assert_eq!(key.segments().len(), 2);

Implementations

impl Key

pub fn from_str(s: &str) -> ConfigResult<Self>

Parse a key from a string path.

Errors

Returns ConfigError::InvalidKey if the key format is invalid.

pub const fn from_segments(segments: Vec<KeySegment>) -> Self

Creates a key from a vector of segments.

pub fn segments(&self) -> &[KeySegment]

Returns the segments that make up this key.

pub const fn len(&self) -> usize

Returns the number of segments in this key.

pub const fn is_empty(&self) -> bool

Returns true if this key has no segments.

pub fn parent(&self) -> Option<Self>

Returns the parent key (all segments except the last).

Returns None if this key has only one segment.

pub fn last_segment(&self) -> Option<&KeySegment>

Returns the last segment of this key.

pub fn first_segment(&self) -> Option<&KeySegment>

Returns the first segment of this key.

pub fn append(self, segment: KeySegment) -> Self

Appends a segment to the end of this key.

pub fn to_key_string(&self) -> String

Converts this key back to a string representation.

pub fn traverse<F, T>(&self, f: F) -> ConfigResult<T>

where F: FnMut(&KeySegment) -> ConfigResult<T>,

Traverse the key segments with a function.

Errors

Returns ConfigError::InvalidKey if the key is empty.

pub fn walk<F>(&self, f: F) -> ConfigResult<()>

where F: FnMut(usize, &KeySegment) -> ConfigResult<()>,

Walk through all segments with a function.

Errors

Returns ConfigError::InvalidKey if any segment traversal fails.

pub fn head(&self, n: usize) -> Option<Self>

Returns the first n segments of this key.

Returns None if n is 0 or greater than the number of segments.

pub fn tail(&self, n: usize) -> Option<Self>

Returns the last n segments of this key.

Returns None if n is 0 or greater than the number of segments.

pub fn child(&self, segment: KeySegment) -> Self

Returns a new key with the given segment appended.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl Display for Key

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

Formats the value using the given formatter.

impl From<Vec<KeySegment>> for Key

fn from(segments: Vec<KeySegment>) -> Self

Converts to this type from the input type.

impl Hash for Key

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 PartialEq for Key

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

impl StructuralPartialEq for Key