Enum Shell 

#[non_exhaustive]
pub enum Shell {
    Bash,
    Zsh,
    Fish,
    Elvish,
    PowerShell,
}

The shells a script can be written for.

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

Bash

GNU bash, with its complete -F.

Zsh

zsh’s completion system (compinit).

Fish

fish.

Elvish

Elvish.

PowerShell

PowerShell.

Implementations

impl Shell

pub const ALL: &'static [Shell]

Every shell a script can be written for.

pub const fn as_str(self) -> &'static str

The shell’s name: bash, zsh, fish, elvish, powershell.

pub fn from_name(name: &str) -> Option<Shell>

The shell named name, if a script can be written for it.

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Shell

impl Debug for Shell

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

Formats the value using the given formatter.

impl Display for Shell

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

Formats the value using the given formatter.

impl Eq for Shell

impl FromArg for Shell

So a program’s own --completions <SHELL> flag can be a Shell.

const CHOICES: &'static [&'static str]

The values accepted, when there is a fixed set: help lists them as [possible values: …]. Empty by default; #[derive(ValueEnum)] fills it with each visible variant’s name.

fn from_arg(value: &BStr) -> Result<Self, BoxError>

Convert one value.

const HINT: Hint = crate::complete::Hint::Nothing

What the value is, for the shell that completes it, when a field states no hint. Nothing a shell knows by default: a number, an address, a type of the program. A PathBuf, a String and an OsString are a file: a word is one more often than not, and a shell that offers files stops no other word from being typed.

impl Hash for Shell

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Shell

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Shell