Enum clap_builder::error::ContextKind

#[non_exhaustive]
pub enum ContextKind {
    InvalidSubcommand,
    InvalidArg,
    PriorArg,
    ValidSubcommand,
    ValidValue,
    InvalidValue,
    ActualNumValues,
    ExpectedNumValues,
    MinValues,
    SuggestedCommand,
    SuggestedSubcommand,
    SuggestedArg,
    SuggestedValue,
    TrailingArg,
    Suggested,
    Usage,
    Custom,
}

Semantics for a piece of error information

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.

InvalidSubcommand

The cause of the error

InvalidArg

The cause of the error

PriorArg

Existing arguments

ValidSubcommand

Accepted subcommands

ValidValue

Accepted values

InvalidValue

Rejected values

ActualNumValues

Number of values present

ExpectedNumValues

Number of allowed values

MinValues

Minimum number of allowed values

SuggestedCommand

Potential fix for the user

SuggestedSubcommand

Potential fix for the user

SuggestedArg

Potential fix for the user

SuggestedValue

Potential fix for the user

TrailingArg

Trailing argument

Suggested

Potential fix for the user

Usage

A usage string

Custom

An opaque message to the user

Implementations

impl ContextKind

pub fn as_str(self) -> Option<&'static str>

End-user description of the error case, where relevant

Trait Implementations

impl Clone for ContextKind

fn clone(&self) -> ContextKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContextKind

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

Formats the value using the given formatter.

impl Display for ContextKind

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

Formats the value using the given formatter.

impl Hash for ContextKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<ContextKind> for ContextKind

fn eq(&self, other: &ContextKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ContextKind

impl Eq for ContextKind

impl StructuralEq for ContextKind

impl StructuralPartialEq for ContextKind