Enum Shell 

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

A shell that completions can be generated for.

Variants

Bash

GNU Bash, via complete -F.

Zsh

Z shell, via an autoloaded #compdef function.

Fish

fish, via complete -c.

PowerShell

PowerShell, via Register-ArgumentCompleter -Native.

Implementations

impl Shell

pub const ALL: [Self; 4]

Every supported shell, in a stable order.

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

The lowercase name used on the command line and in file paths.

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

The filename each shell expects to find in its completions directory.

These are not cosmetic. Bash looks for a file named exactly after the command, zsh requires the leading underscore to autoload the function, and fish requires the .fish extension.

Examples

use ssg::cmd::completions::Shell;
assert_eq!(Shell::Bash.file_name("ssg"), "ssg");
assert_eq!(Shell::Zsh.file_name("ssg"), "_ssg");
assert_eq!(Shell::Fish.file_name("ssg"), "ssg.fish");

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

Parses a shell name, as accepted on the command line.

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

fn cmp(&self, other: &Shell) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &Shell) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Shell