#[non_exhaustive]
pub enum ValueHint {
Show 13 variants Unknown, Other, AnyPath, FilePath, DirPath, ExecutablePath, CommandName, CommandString, CommandWithArguments, Username, Hostname, Url, EmailAddress,
}
Expand description

Provide shell with hint on how to complete an argument.

See Arg::value_hint to set this on an argument.

See the clap_complete crate for completion script generation.

Overview of which hints are supported by which shell:

Hintzshfish1
AnyPathYesYes
FilePathYesYes
DirPathYesYes
ExecutablePathYesPartial
CommandNameYesYes
CommandStringYesPartial
CommandWithArgumentsYes
UsernameYesYes
HostnameYesYes
UrlYes
EmailAddressYes

  1. fish completions currently only support named arguments (e.g. -o or –opt), not positional arguments. 

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.

Unknown

Default value if hint is not specified. Follows shell default behavior, which is usually auto-completing filenames.

Other

None of the hints below apply. Disables shell completion for this argument.

AnyPath

Any existing path.

FilePath

Path to a file.

DirPath

Path to a directory.

ExecutablePath

Path to an executable file.

CommandName

Name of a command, without arguments. May be relative to PATH, or full path to executable.

CommandString

A single string containing a command and its arguments.

CommandWithArguments

Capture the remaining arguments as a command name and arguments for that command. This is common when writing shell wrappers that execute anther command, for example sudo or env.

This hint is special, the argument must be a positional argument and have .multiple_values(true) and Command must use Command::trailing_var_arg(true). The result is that the command line my_app ls -la / will be parsed as ["ls", "-la", "/"] and clap won’t try to parse the -la argument itself.

Username

Name of a local operating system user.

Hostname

Host name of a computer. Shells usually parse /etc/hosts and .ssh/known_hosts to complete hostnames.

Url

Complete web address.

EmailAddress

Email address.

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
Returns the “default value” for a type. Read more
The associated error which can be returned from parsing.
Parses a string s to return a value of this type. 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
Compare self to key and return true if they are equal.

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