Enum ConfigValidationError 

#[non_exhaustive]
pub enum ConfigValidationError {
    ValueTooHigh {
        field: &'static str,
        value: String,
        max: String,
    },
    ValueTooLow {
        field: &'static str,
        value: String,
        min: String,
    },
    ValueInvalid {
        field: &'static str,
        reason: String,
    },
    ValueMissing {
        field: &'static str,
    },
}

Configuration validation error types.

This enum represents different types of validation failures that can occur when validating configuration parameters. Each variant includes the field name and relevant values for debugging.

Example

use ccxt_core::error::ConfigValidationError;

let err = ConfigValidationError::ValueTooHigh {
    field: "max_retries",
    value: "15".to_string(),
    max: "10".to_string(),
};
assert!(err.to_string().contains("max_retries"));
assert!(err.to_string().contains("15"));

Variants (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.

ValueTooHigh

Field value exceeds the maximum allowed value.

Fields

field: &'static str

The name of the configuration field

value: String

The actual value that was provided

max: String

The maximum allowed value

ValueTooLow

Field value is below the minimum allowed value.

Fields

field: &'static str

The name of the configuration field

value: String

The actual value that was provided

min: String

The minimum allowed value

ValueInvalid

Field value is invalid for reasons other than range.

Fields

field: &'static str

The name of the configuration field

reason: String

The reason why the value is invalid

ValueMissing

Required field is missing.

Fields

field: &'static str

The name of the missing configuration field

Implementations

impl ConfigValidationError

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

Returns the field name associated with this error.

Example

use ccxt_core::error::ConfigValidationError;

let err = ConfigValidationError::ValueTooHigh {
    field: "max_retries",
    value: "15".to_string(),
    max: "10".to_string(),
};
assert_eq!(err.field_name(), "max_retries");

pub fn too_high<V: Display, M: Display>( field: &'static str, value: V, max: M, ) -> Self

Creates a new ValueTooHigh error.

Example

use ccxt_core::error::ConfigValidationError;

let err = ConfigValidationError::too_high("max_retries", 15, 10);
assert!(err.to_string().contains("max_retries"));

pub fn too_low<V: Display, M: Display>( field: &'static str, value: V, min: M, ) -> Self

Creates a new ValueTooLow error.

Example

use ccxt_core::error::ConfigValidationError;

let err = ConfigValidationError::too_low("base_delay_ms", 5, 10);
assert!(err.to_string().contains("base_delay_ms"));

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

Creates a new ValueInvalid error.

Example

use ccxt_core::error::ConfigValidationError;

let err = ConfigValidationError::invalid("capacity", "capacity cannot be zero");
assert!(err.to_string().contains("capacity"));

pub fn missing(field: &'static str) -> Self

Creates a new ValueMissing error.

Example

use ccxt_core::error::ConfigValidationError;

let err = ConfigValidationError::missing("api_key");
assert!(err.to_string().contains("api_key"));

Trait Implementations

impl Clone for ConfigValidationError

fn clone(&self) -> ConfigValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigValidationError

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

Formats the value using the given formatter.

impl Display for ConfigValidationError

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

Formats the value using the given formatter.

impl Error for ConfigValidationError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

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

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.

impl From<ConfigValidationError> for Error

fn from(e: ConfigValidationError) -> Self

Converts to this type from the input type.

impl PartialEq for ConfigValidationError

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

impl StructuralPartialEq for ConfigValidationError