Skip to main content

## ContextKind

# Enum 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,
    }

Available on crate feature `error-context` only.
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 duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Copy for ContextKind

Source§

### impl Debug for ContextKind

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Display for ContextKind

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Eq for ContextKind

Source§

### impl Hash for ContextKind

Source§

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

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, Self: Sized,

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

### impl PartialEq for ContextKind

Source§

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

Equality operator `==`. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator `!=`. Read more
Source§

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

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

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

Source§

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

Returns the argument unchanged.

Source§

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

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,

Source§

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

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

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.