Skip to main content

UnknownKeyInfo

Struct UnknownKeyInfo 

Source
pub struct UnknownKeyInfo {
    pub key: String,
    pub path: PathBuf,
    pub line: usize,
    pub source: Option<Arc<str>>,
}
Expand description

A single unknown-key violation discovered during strict-mode validation.

Flat, pattern-match-free data carrier: no nested enums to unwrap. Produced during strict-mode validation and surfaced through ClapfigError::unknown_keys.

source holds the full file contents at the time of validation, shared cheaply across all infos from the same file. Renderers use it to draw source snippets; it is None when the source is not retained (e.g. after round-tripping through a non-data path).

Fields§

§key: String

Dotted key path that was not recognized by the config schema (e.g. "database.typo").

§path: PathBuf

Path to the config file that contained the unknown key.

§line: usize

1-indexed line number where the key was found, or 0 if the line could not be located (best-effort heuristic).

§source: Option<Arc<str>>

Full contents of the config file, shared across all infos from the same file. Used by renderers for source snippets.

Implementations§

Source§

impl UnknownKeyInfo

Source

pub fn leaf(&self) -> &str

Returns the leaf segment of the dotted key (e.g. "typo" for "database.typo"). Used by renderers to highlight the offending token.

Trait Implementations§

Source§

impl Clone for UnknownKeyInfo

Source§

fn clone(&self) -> UnknownKeyInfo

Returns a duplicate 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 UnknownKeyInfo

Source§

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

Formats the value using the given formatter. Read more

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, 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.