Enum Shell 

pub enum Shell {
    Bash,
    Fish,
    Powershell,
    Cmd,
    Zsh,
    Nushell,
    Csh,
    Ksh,
}

Shells for which virtualenv activation scripts are available.

Variants

Bash

Bourne Again SHell (bash)

Fish

Friendly Interactive SHell (fish)

Powershell

PowerShell

Cmd

Cmd (Command Prompt)

Zsh

Z SHell (zsh)

Nushell

Nushell

Csh

C SHell (csh)

Ksh

Korn SHell (ksh)

Implementations

impl Shell

pub fn from_env() -> Option<Self>

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.

pub fn from_shell_path(path: impl AsRef<Path>) -> Option<Self>

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

Examples

use crate::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 supports_update(self) -> bool

Returns true if the shell supports a PATH update command.

pub fn configuration_files(self) -> Vec<PathBuf>

Return the configuration files that should be modified to append to a shell’s PATH.

Some of the logic here is based on rustup’s rc file detection.

See: https://github.com/rust-lang/rustup/blob/fede22fea7b160868cece632bd213e6d72f8912f/src/cli/self_update/shell.rs#L197

pub fn contains_path(path: &Path) -> bool

Returns true if the given path is on the PATH in this shell.

pub fn prepend_path(self, path: &Path) -> Option<String>

Returns the command necessary to prepend a directory to the PATH in this shell.

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

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