Enum ParseError 

pub enum ParseError {
    UnknownFlag {
        flag: String,
        suggestions: Vec<String>,
    },
    MissingFlagValue {
        flag: String,
        expected_type: String,
    },
    InvalidValue {
        flag: String,
        value: String,
        expected_type: String,
        reason: String,
    },
    InvalidChoice {
        flag: String,
        value: String,
        allowed: Vec<String>,
    },
    MissingRequired {
        flag: String,
    },
    UnknownCommand {
        tokens: Vec<String>,
        suggestions: Vec<String>,
    },
    MissingResource {
        domain: String,
        available: Vec<String>,
    },
    MissingVerb {
        domain: String,
        resource: String,
        available: Vec<String>,
    },
    HelpRequested {
        text: String,
    },
    VersionRequested {
        text: String,
    },
    Other(String),
}

Variants

UnknownFlag

Unknown flag not in schema

Fields

flag: String

suggestions: Vec<String>

MissingFlagValue

Flag expects a value but none provided

Fields

flag: String

expected_type: String

InvalidValue

Flag value doesn’t match expected type

Fields

flag: String

value: String

expected_type: String

reason: String

InvalidChoice

Flag value not in allowed choices

Fields

flag: String

value: String

allowed: Vec<String>

MissingRequired

Required flag not provided

Fields

flag: String

UnknownCommand

Unknown command (domain/resource/verb not found)

Fields

tokens: Vec<String>

suggestions: Vec<String>

MissingResource

Domain found but missing resource

Fields

domain: String

available: Vec<String>

MissingVerb

Domain+resource found but missing verb

Fields

domain: String

resource: String

available: Vec<String>

HelpRequested

Help was requested (not really an error)

Fields

text: String

VersionRequested

Version was requested (not really an error)

Fields

text: String

Other(String)

Generic error with message

Implementations

impl ParseError

pub fn format_human(&self) -> String

Format as human-readable error message with colors

pub fn format_json(&self) -> String

Format as JSON error object

pub fn is_info(&self) -> bool

Is this a “not really an error” variant (help/version)?

Trait Implementations

impl Clone for ParseError

fn clone(&self) -> ParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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, f: &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.