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§

End-user description of the error case, where relevant

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.