Enum ConfigError

Source
#[non_exhaustive]
pub enum ConfigError { InvalidColor { value: String, span: Option<SourceSpan>, source_code: Option<String>, }, OutOfRange { key: String, value: i64, min: i64, max: i64, span: Option<SourceSpan>, source_code: Option<String>, }, UnknownKey { key: String, similar: Vec<String>, span: Option<SourceSpan>, source_code: Option<String>, }, MissingField { key: String, expected_type: String, }, TypeMismatch { key: String, expected: String, actual: String, span: Option<SourceSpan>, source_code: Option<String>, }, ParseError { source: Error, src: String, }, InvalidTheme { value: String, span: Option<SourceSpan>, source_code: Option<String>, }, InvalidPosition { value: String, span: Option<SourceSpan>, source_code: Option<String>, }, DeprecatedKey { key: String, replacement: String, removed_in: String, span: Option<SourceSpan>, source_code: Option<String>, }, FontNotFound { family: String, }, }
Expand description

Errors that occur during configuration parsing and validation.

ConfigError provides detailed, actionable error messages for configuration problems. Each variant includes context about what went wrong and how to fix it.

§Error Codes

Every error has a unique code (e.g., fern::config::invalid_color) that can be looked up in documentation for detailed explanations.

§Severity Levels

Most configuration errors are Severity::Error, but some are warnings:

VariantSeverityBehavior
UnknownKeyWarningConfig loads, key ignored
DeprecatedKeyWarningConfig loads, warning shown
OthersErrorConfig fails to load

§Example

ⓘ
use fernctl::error::ConfigError;

let error = ConfigError::InvalidColor {
    value: "#gg0000".to_string(),
    span: None,
    location: None,
};

// Rich error output with miette
println!("{:?}", miette::Report::new(error));

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

InvalidColor

Invalid color format.

The provided value is not a valid hex color. Colors must be in the format #RRGGBB or #RRGGBBAA where each character is a hex digit.

§Valid Examples

  • #89b4fa — 6-digit hex (opaque)
  • #89b4fa80 — 8-digit hex (with alpha)
  • #fff — 3-digit shorthand (expands to #ffffff)

§Invalid Examples

  • #gg0000 — Contains non-hex characters
  • 89b4fa — Missing # prefix
  • #89b — Invalid length (not 3, 6, or 8)

Fields

§value: String

The invalid color value.

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

OutOfRange

Value is outside the valid range.

Numeric values must fall within specified bounds. This error indicates the value is too large or too small.

Fields

§key: String

The configuration key.

§value: i64

The invalid value.

§min: i64

Minimum allowed value.

§max: i64

Maximum allowed value.

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

UnknownKey

Unknown configuration key.

The configuration contains a key that is not recognized. This is a warning, not an error — the configuration will still load, but the unknown key will be ignored.

§Common Causes

  • Typo in key name
  • Using a key from a different version
  • Copy-pasting from incompatible configuration

Fields

§key: String

The unrecognized key.

§similar: Vec<String>

Similar valid keys (for “did you mean?” suggestions).

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

MissingField

Required field is missing.

A required configuration field was not provided and has no default value.

Fields

§key: String

The missing key.

§expected_type: String

Expected type description.

§

TypeMismatch

Type mismatch in configuration value.

The value has the wrong type. For example, a string was provided where a number was expected.

Fields

§key: String

The configuration key.

§expected: String

Expected type name.

§actual: String

Actual type name.

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

ParseError

TOML syntax error.

The configuration file is not valid TOML. This is a fatal error because no configuration can be loaded.

Fields

§source: Error

The underlying TOML parse error.

§src: String

The source file content for error display.

§

InvalidTheme

Invalid theme name.

The theme must be one of: “dark”, “light”, or “auto”.

Fields

§value: String

The invalid theme value.

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

InvalidPosition

Invalid bar position.

The bar position must be “top” or “bottom”.

Fields

§value: String

The invalid position value.

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

DeprecatedKey

Deprecated configuration key.

This key still works but will be removed in a future version. This is a warning.

Fields

§key: String

The deprecated key.

§replacement: String

The replacement key to use.

§removed_in: String

Version when this key will be removed.

§span: Option<SourceSpan>

Source span for highlighting.

§source_code: Option<String>

Location in config file.

§

FontNotFound

Invalid font family.

The specified font is not available on the system.

Fields

§family: String

The font family that was not found.

Implementations§

Source§

impl ConfigError

Source

pub fn severity(&self) -> Severity

Returns the severity level of this error.

Most config errors are Severity::Error, but some are warnings.

Source

pub fn code(&self) -> &'static str

Returns the error code for documentation lookup.

Source

pub fn title(&self) -> String

Returns a short title for notification display.

Trait Implementations§

Source§

impl Debug for ConfigError

Source§

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

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

impl Diagnostic for ConfigError

Source§

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.
Source§

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s [Diagnostic::source_code]
Source§

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s [Diagnostic::labels] to.
§

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic. Read more
§

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?
§

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.
§

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.
§

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.
Source§

impl Display for ConfigError

Source§

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

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

impl Error for ConfigError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<ConfigError> for FernError

Source§

fn from(source: ConfigError) -> Self

Converts to this type from the input type.
Source§

impl Notifiable for ConfigError

Source§

fn severity(&self) -> Severity

Returns the severity level of this notification. Read more
Source§

fn title(&self) -> String

Returns a short title for the notification header. Read more
Source§

fn body(&self) -> String

Returns the detailed body text of the notification. Read more
Source§

fn suggestion(&self) -> Option<String>

Returns an optional suggestion for fixing the problem. Read more
Source§

fn code(&self) -> Option<&'static str>

Returns an optional error code for documentation lookup. Read more
Source§

fn to_notification(&self) -> Notification

Converts this notifiable into a Notification struct. 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> 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.

§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
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.