Enum ValueHint 

pub enum ValueHint {
    Unknown,
    Other,
    FilePath,
    AnyPath,
    DirPath,
    ExecutablePath,
    CommandName,
    CommandString,
    CommandWithArguments,
    Username,
    Hostname,
    Url,
    EmailAddress,
}

A value’s shell-native completion class for #[usage(value_hint = ...)].

This lives in the runtime crate so a declaration never needs clap merely to describe what kind of path a shell should offer. It is metadata only and adds no work to a successful parse.

Variants

Unknown

Let the shell use its normal fallback behavior.

Other

No structured hint applies; suppress the shell’s path fallback.

FilePath

A path to a file.

AnyPath

A path to either a file or a directory.

DirPath

A path to a directory.

ExecutablePath

A path to an executable file.

CommandName

A command name, resolved through the shell’s command table and PATH.

CommandString

One string containing a command and any arguments.

CommandWithArguments

A trailing argv vector: complete the first value as a command, then its arguments.

Username

A local operating-system user name.

Hostname

A host name known to the shell or operating system.

Url

A web address. This suppresses path fallback but offers no finite candidate set.

EmailAddress

An email address. This suppresses path fallback but offers no finite candidate set.

Trait Implementations

impl Clone for ValueHint

fn clone(&self) -> ValueHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ValueHint

impl Debug for ValueHint

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

Formats the value using the given formatter.

impl Eq for ValueHint

impl PartialEq for ValueHint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValueHint