# Enum clap::error::ContextKind

source · [−]

    #[non_exhaustive]
    pub enum ContextKind {
    Show 17 variants    InvalidSubcommand,
        InvalidArg,
        PriorArg,
        ValidSubcommand,
        ValidValue,
        InvalidValue,
        ActualNumValues,
        ExpectedNumValues,
        MinValues,
        SuggestedCommand,
        SuggestedSubcommand,
        SuggestedArg,
        SuggestedValue,
        TrailingArg,
        Suggested,
        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

### `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

source

### impl ContextKind

source

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

End-user description of the error case, where relevant

## Trait Implementations

source

### impl Clone for ContextKind

source

#### 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

source

### impl Debug for ContextKind

source

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

Formats the value using the given formatter. Read more

source

### impl Display for ContextKind

source

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

Formats the value using the given formatter. Read more

source

### impl Hash for ContextKind

source

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

Feeds this value into the given `Hasher`. Read more

1.3.0 · source

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

Feeds a slice of this type into the given `Hasher`. Read more

source

### impl PartialEq<ContextKind> for ContextKind

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl Copy for ContextKind

source

### impl Eq for ContextKind

source

### impl StructuralEq for ContextKind

source

### impl StructuralPartialEq for ContextKind

## Auto Trait Implementations

### impl RefUnwindSafe for ContextKind

### impl Send for ContextKind

### impl Sync for ContextKind

### impl Unpin for ContextKind

### impl UnwindSafe for ContextKind

## Blanket Implementations

source

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

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

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

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

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

source

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

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

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

source

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

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

source

### impl<T> ToString for T where
T: Display + ?Sized,

source

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more

source

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

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

### 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.

const: unstable · source

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

Performs the conversion.