Enum clap_complete::shells::Shell

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

Shell with auto-generated completion script available.

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

Bourne Again SHell (bash)

Elvish

Elvish shell

Fish

Friendly Interactive SHell (fish)

PowerShell

PowerShell

Zsh

Z SHell (zsh)

Implementations

impl Shell

pub fn from_shell_path<P: AsRef<Path>>(path: P) -> Option<Shell>

Parse a shell from a path to the executable for the shell

Examples

use clap_complete::shells::Shell;

assert_eq!(Shell::from_shell_path("/bin/bash"), Some(Shell::Bash));
assert_eq!(Shell::from_shell_path("/usr/bin/zsh"), Some(Shell::Zsh));
assert_eq!(Shell::from_shell_path("/opt/my_custom_shell"), None);

pub fn from_env() -> Option<Shell>

Determine the user’s current shell from the environment

This will read the SHELL environment variable and try to determine which shell is in use from that.

If SHELL is not set, then on windows, it will default to powershell, and on other OSes it will return None.

If SHELL is set, but contains a value that doesn’t correspond to one of the supported shell types, then return None.

Example:

use clap_complete::{generate, shells::Shell};
let mut cmd = build_cli();
generate(Shell::from_env().unwrap_or(Shell::Bash), &mut cmd, "myapp", &mut std::io::stdout());

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Shell

Returns a copy of the value.

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

Performs copy-assignment from source.

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

type Err = String

The associated error which can be returned from parsing.

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

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

impl Generator for Shell

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

Returns the file name that is created when this generator is called during compile time.

fn generate(&self, cmd: &Command, buf: &mut dyn Write)

Generates output out of clap::Command.

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: &Shell) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Copy for Shell

impl Eq for Shell

impl StructuralPartialEq for Shell