Skip to main content

ConfigError

Enum ConfigError 

Source
pub enum ConfigError {
    OutOfRange {
        param: &'static str,
        constraint: &'static str,
        value: String,
    },
    Invalid {
        param: &'static str,
        reason: String,
    },
}
Available on crate feature alloc only.
Expand description

Structured error for configuration validation failures.

Instead of opaque strings, each variant carries the parameter name and constraint so callers can programmatically inspect what went wrong.

Requires the alloc feature for String fields.

Variants§

§

OutOfRange

A parameter value is outside its valid range.

§Examples

n_steps must be > 0 (got 0)
learning_rate must be in (0, 1] (got 1.5)

Fields

§param: &'static str

The parameter name (e.g. "n_steps", "drift_detector.Adwin.delta").

§constraint: &'static str

The constraint that was violated (e.g. "must be > 0").

§value: String

The actual value that was provided.

§

Invalid

A parameter is invalid for a structural reason, typically involving a relationship between two parameters.

§Examples

split_reeval_interval must be >= grace_period (200), got 50
drift_detector.Ddm.drift_level must be > warning_level (3.0), got 2.0

Fields

§param: &'static str

The parameter name.

§reason: String

Why the value is invalid.

Implementations§

Source§

impl ConfigError

Source

pub fn out_of_range( param: &'static str, constraint: &'static str, value: impl Display, ) -> Self

Convenience for the common “value out of range” case.

Source

pub fn invalid(param: &'static str, reason: impl Into<String>) -> Self

Convenience for the “invalid relationship” case.

Trait Implementations§

Source§

impl Clone for ConfigError

Source§

fn clone(&self) -> ConfigError

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 ConfigError

Source§

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

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

impl Display for ConfigError

Source§

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

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

impl Error for ConfigError

Available on crate feature std only.
1.30.0 · 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 IrithyllError

Source§

fn from(e: ConfigError) -> Self

Converts to this type from the input type.

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.