Skip to main content

## UnknownArgumentValueParser

# Struct UnknownArgumentValueParser

Source

    pub struct UnknownArgumentValueParser { /* private fields */ }

Expand description

When encountered, report `ErrorKind::UnknownArgument`

Useful to help users migrate, either from old versions or similar tools.

## §Examples

    let cmd = Command::new("mycmd")
        .args([
            Arg::new("current-dir")
                .short('C'),
            Arg::new("current-dir-unknown")
                .long("cwd")
                .aliases(["current-dir", "directory", "working-directory", "root"])
                .value_parser(clap::builder::UnknownArgumentValueParser::suggest_arg("-C"))
                .hide(true),
        ]);

    // Use a supported version of the argument
    let matches = cmd.clone().try_get_matches_from(["mycmd", "-C", ".."]).unwrap();
    assert!(matches.contains_id("current-dir"));
    assert_eq!(
        matches.get_many::<String>("current-dir").unwrap_or_default().map(|v| v.as_str()).collect::<Vec<_>>(),
        vec![".."]
    );

    // Use one of the invalid versions
    let err = cmd.try_get_matches_from(["mycmd", "--cwd", ".."]).unwrap_err();
    assert_eq!(err.kind(), clap::error::ErrorKind::UnknownArgument);

## Implementations§

Source§

### impl UnknownArgumentValueParser

Source

#### pub fn suggest_arg(arg: impl Into<Str>) -> UnknownArgumentValueParser

Suggest an alternative argument

Source

#### pub fn suggest(text: impl Into<StyledStr>) -> UnknownArgumentValueParser

Provide a general suggestion

Source

#### pub fn and_suggest( self, text: impl Into<StyledStr>, ) -> UnknownArgumentValueParser

Extend the suggestions

## Trait Implementations§

Source§

### impl Clone for UnknownArgumentValueParser

Source§

#### fn clone(&self) -> UnknownArgumentValueParser

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 Debug for UnknownArgumentValueParser

Source§

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

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

### impl TypedValueParser for UnknownArgumentValueParser

Source§

#### type Value = String

Argument’s value type
Source§

#### fn parse_ref( &self, cmd: &Command, arg: Option<&Arg>, value: &OsStr, ) -> Result<<UnknownArgumentValueParser as TypedValueParser>::Value, Error>

Parse the argument value Read more
Source§

#### fn parse_ref_( &self, cmd: &Command, arg: Option<&Arg>, _value: &OsStr, source: ValueSource, ) -> Result<<UnknownArgumentValueParser as TypedValueParser>::Value, Error>

Parse the argument value Read more
Source§

#### fn parse( &self, cmd: &Command, arg: Option<&Arg>, value: OsString, ) -> Result<Self::Value, Error>

Parse the argument value Read more
Source§

#### fn parse_( &self, cmd: &Command, arg: Option<&Arg>, value: OsString, _source: ValueSource, ) -> Result<Self::Value, Error>

Parse the argument value Read more
Source§

#### fn possible_values( &self, ) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>>

Reflect on enumerated value properties Read more
Source§

#### fn map<T, F>(self, func: F) -> MapValueParser<Self, F>
where T: Send + Sync + Clone, F: Fn(Self::Value) -> T + Clone,

Adapt a `TypedValueParser` from one value to another Read more
Source§

#### fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>
where F: Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync + 'static, T: Send + Sync + Clone, E: Into<Box<dyn Error + Sync + Send>>,

Adapt a `TypedValueParser` from one value to another Read more

## Auto Trait Implementations§

§

### impl Freeze for UnknownArgumentValueParser

§

### impl RefUnwindSafe for UnknownArgumentValueParser

§

### impl Send for UnknownArgumentValueParser

§

### impl Sync for UnknownArgumentValueParser

§

### impl Unpin for UnknownArgumentValueParser

§

### impl UnsafeUnpin for UnknownArgumentValueParser

§

### impl UnwindSafe for UnknownArgumentValueParser

## 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<I> IntoResettable<ValueParser> for I
where I: Into<ValueParser>,

Source§

#### fn into_resettable(self) -> Resettable<ValueParser>

Convert to the intended resettable type
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, 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.