Enum clap::error::ContextKind

#[non_exhaustive]pub enum ContextKind {
Show 17 variants    InvalidSubcommand,
    InvalidArg,
    PriorArg,
    ValidValue,
    InvalidValue,
    ActualNumValues,
    ExpectedNumValues,
    MinValues,
    ActualNumOccurrences,
    MaxOccurrences,
    SuggestedCommand,
    SuggestedSubcommand,
    SuggestedArg,
    SuggestedValue,
    TrailingArg,
    Usage,
    Custom,
}

Expand description

Semantics for a piece of error information

Variants (Non-exhaustive)§

This enum is marked as 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

ValidValue

Accepted values

InvalidValue

Rejected values

ActualNumValues

Number of values present

ExpectedNumValues

Number of allowed values

MinValues

Minimum number of allowed values

ActualNumOccurrences

Number of occurrences present

MaxOccurrences

Maximum number of allowed occurrences

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

Usage

A usage string

Custom

An opaque message to the user

Trait Implementations§

impl Clone for ContextKind

fn clone(&self) -> ContextKind

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for ContextKind

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

Formats the value using the given formatter. Read more

impl PartialEq for ContextKind

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

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

1.0.0 · source§

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 StructuralPartialEq for ContextKind

Auto Trait Implementations§

impl Freeze for ContextKind

impl RefUnwindSafe for ContextKind

impl Send for ContextKind

impl Sync for ContextKind

impl Unpin for ContextKind

impl UnwindSafe for ContextKind

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.