Struct SettingPath 

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

A dotted path to one setting, such as sources.work.config.root.

Implementations

impl SettingPath

pub fn new(segments: Vec<String>, source: &str) -> Result<Self, ConfigError>

Build a path from segments, refusing an empty one.

Errors

Returns ConfigError::Setting when there are no segments or one is empty — --set .plugin=x and --set a..b=x both address nothing.

pub fn parse(dotted: &str) -> Result<Self, ConfigError>

Parse a dotted path such as sources.work.config.root.

Errors

Returns ConfigError::Setting when dotted has an empty segment.

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

The segments, outermost first.

Trait Implementations

impl Clone for SettingPath

fn clone(&self) -> SettingPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingPath

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

Formats the value using the given formatter.

impl Display for SettingPath

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

Formats the value using the given formatter.

impl Eq for SettingPath

impl From<SettingPath> for String

fn from(value: SettingPath) -> Self

Converts to this type from the input type.

impl Hash for SettingPath

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 JsonSchema for SettingPath

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for SettingPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SettingPath

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SettingPath