Enum Shell 

pub enum Shell {
    Bash,
    Zsh,
    Fish,
}

Available on crate feature shell only.

A shell a CLI prints a script for: the set Homebrew installs completion for by default.

Every verb that takes a Shell supports every variant. A shell joins the set only when each of those verbs has a tested form for it.

The set is closed, and the enum is deliberately not #[non_exhaustive]. A caller matches on every variant, so the compiler shows each place a new shell needs a script. Adding a shell is therefore a breaking release.

The command-line value is the lowercase name: bash, zsh, or fish.

Variants

Bash

Bash.

Zsh

Zsh.

Fish

Fish.

Implementations

impl Shell

pub fn script(self, bin: &str) -> Result<Script>

Available on crate feature completion only.

The registration script for bin, which the shell finds on PATH at each TAB.

The script calls bin by name, never by the path that produced it. A script Homebrew writes from a versioned directory then keeps working after the next upgrade.

Errors

Returns an error when the script clap_complete writes is not UTF-8, which a bin that is a &str never causes.

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 Eq for Shell

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 Serialize for Shell

Available on crate feature json only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Shell

impl ValueEnum for Shell

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.