Enum ConfigError 

pub enum ConfigError {
    FileNotFound {
        path: PathBuf,
    },
    UnsupportedFormat {
        extension: String,
    },
    YamlParse {
        source: Error,
        line: Option<usize>,
        column: Option<usize>,
    },
    JsonParse {
        source: Error,
        line: usize,
        column: usize,
    },
    InvalidSchema {
        reason: String,
        path: Option<String>,
    },
    DuplicateCommand {
        name: String,
    },
    UnknownType {
        type_name: String,
        context: String,
    },
    Inconsistency {
        details: String,
    },
}

Errors related to loading and parsing the configuration file

These errors occur when loading the commands.yaml or commands.json file and its structural validation.

Variants

FileNotFound

Configuration file not found

Example

use dynamic_cli::error::ConfigError;
use std::path::PathBuf;

let error = ConfigError::FileNotFound {
    path: PathBuf::from("missing.yaml"),
};

Fields

path: PathBuf

UnsupportedFormat

Unsupported file extension

Only .yaml, .yml and .json are supported.

Fields

extension: String

YamlParse

YAML parsing error

Fields

source: Error

line: Option<usize>

Position in the file (if available)

column: Option<usize>

JsonParse

JSON parsing error

Fields

source: Error

line: usize

Position in the file

column: usize

InvalidSchema

Invalid configuration schema

The file structure doesn’t match the expected format.

Fields

reason: String

path: Option<String>

Path in the config (e.g., “commands[0].options[2].type”)

DuplicateCommand

Duplicate command (same name or alias)

Fields

name: String

UnknownType

Unknown argument type

Fields

type_name: String

context: String

Inconsistency

Inconsistent configuration

For example, a default value that’s not in the allowed choices.

Fields

details: String

Implementations

impl ConfigError

pub fn yaml_parse_with_location(source: Error) -> Self

Create a YAML error with position

Extracts position information from the serde_yaml error.

pub fn json_parse_with_location(source: Error) -> Self

Create a JSON error with position

Extracts position information from the serde_json error.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

Formats the value using the given formatter.

impl Error for ConfigError

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<ConfigError> for DynamicCliError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.