Enum Shell 

pub enum Shell {
    Bash,
    Zsh,
    Fish,
    PowerShell,
    NuShell,
}

Shell types for which we can generate completions.

Variants

Bash

Bash shell

Zsh

Zsh shell

Fish

Fish shell

PowerShell

PowerShell

NuShell

NuShell

Implementations

impl Shell

pub fn from_str(s: &str) -> Option<Self>

Parse shell name from string (case-insensitive).

Examples

use help_probe::completion::Shell;

assert_eq!(Shell::from_str("bash"), Some(Shell::Bash));
assert_eq!(Shell::from_str("BASH"), Some(Shell::Bash));
assert_eq!(Shell::from_str("zsh"), Some(Shell::Zsh));
assert_eq!(Shell::from_str("powershell"), Some(Shell::PowerShell));
assert_eq!(Shell::from_str("pwsh"), Some(Shell::PowerShell));
assert_eq!(Shell::from_str("nushell"), Some(Shell::NuShell));
assert_eq!(Shell::from_str("nu"), Some(Shell::NuShell));
assert_eq!(Shell::from_str("invalid"), None);

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Shell

Returns a duplicate 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 PartialEq for Shell

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Shell

impl Eq for Shell

impl StructuralPartialEq for Shell