Enum Shell 

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

Available on crate feature std only.

A shell for which a completion script can be generated.

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

Bash.

Zsh

Zsh.

Fish

Fish.

Implementations

impl Shell

pub const ALL: &'static [Shell]

Every shell, in the order of NAMES.

pub const NAMES: &'static [&'static str]

The name of every shell, as accepted by FromStr and written by Display.

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

The name of the shell: bash, zsh or fish.

pub fn file_name(self, name: &str) -> String

The usual file name of the completion script of the command name: name.bash, _name or name.fish.

pub fn render(self, command: &CommandInfo) -> String

Renders the completion script of command.

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

type Err = ParseValueEnumError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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