Enum ParseError 

pub enum ParseError {
    UnknownCommand {
        command: String,
        suggestions: Vec<String>,
    },
    MissingArgument {
        argument: String,
        command: String,
    },
    MissingOption {
        option: String,
        command: String,
    },
    TooManyArguments {
        command: String,
        expected: usize,
        got: usize,
    },
    UnknownOption {
        flag: String,
        command: String,
        suggestions: Vec<String>,
    },
    TypeParseError {
        arg_name: String,
        expected_type: String,
        value: String,
        details: Option<String>,
    },
    InvalidChoice {
        arg_name: String,
        value: String,
        choices: Vec<String>,
    },
    InvalidSyntax {
        details: String,
        hint: Option<String>,
    },
}

Errors when parsing user commands

These errors occur when analyzing arguments provided by the user in CLI or REPL mode.

Variants

UnknownCommand

Unknown command

The user typed a command that doesn’t exist. Includes suggestions based on Levenshtein distance.

Fields

command: String

suggestions: Vec<String>

Similar command suggestions

MissingArgument

Missing required positional argument

Fields

argument: String

command: String

MissingOption

Missing required option

Fields

option: String

command: String

TooManyArguments

Too many positional arguments

Fields

command: String

expected: usize

got: usize

UnknownOption

Unknown option

Includes similar option suggestions.

Fields

flag: String

command: String

suggestions: Vec<String>

Similar option suggestions

TypeParseError

Type parsing error

The user provided a value that can’t be converted to the expected type (e.g., “abc” for an integer).

Fields

arg_name: String

expected_type: String

value: String

details: Option<String>

Error details (e.g., “not a valid integer”)

InvalidChoice

Value not in allowed choices

Fields

arg_name: String

value: String

choices: Vec<String>

InvalidSyntax

Invalid command syntax

Fields

details: String

hint: Option<String>

Example of correct syntax

Implementations

impl ParseError

pub fn unknown_command_with_suggestions( command: &str, available: &[String], ) -> Self

Create an unknown command error with suggestions

Uses Levenshtein distance to find similar commands.

Arguments

• command - The command typed by the user
• available - List of available commands

Example

use dynamic_cli::error::ParseError;

let available = vec!["simulate".to_string(), "validate".to_string()];
let error = ParseError::unknown_command_with_suggestions("simulat", &available);

pub fn unknown_option_with_suggestions( flag: &str, command: &str, available: &[String], ) -> Self

Create an unknown option error with suggestions

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

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

fn from(source: ParseError) -> Self

Converts to this type from the input type.