Enum ShellEnum 

pub enum ShellEnum {
    Bash(Bash),
    Zsh(Zsh),
    Xonsh(Xonsh),
    CmdExe(CmdExe),
    PowerShell(PowerShell),
    Fish(Fish),
    NuShell(NuShell),
}

A generic Shell implementation for concrete shell types.

Variants

Bash(Bash)

Zsh(Zsh)

Xonsh(Xonsh)

CmdExe(CmdExe)

PowerShell(PowerShell)

Fish(Fish)

NuShell(NuShell)

Implementations

impl ShellEnum

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

Parse a shell from a path to the executable for the 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 set, but contains a value that doesn’t correspond to one of the supported shell types, then return None.

Trait Implementations

impl Clone for ShellEnum

fn clone(&self) -> ShellEnum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellEnum

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

Formats the value using the given formatter.

impl Default for ShellEnum

fn default() -> Self

Returns the “default value” for a type.

impl From<Bash> for ShellEnum

fn from(v: Bash) -> ShellEnum

Converts to this type from the input type.

impl From<CmdExe> for ShellEnum

fn from(v: CmdExe) -> ShellEnum

Converts to this type from the input type.

impl From<Fish> for ShellEnum

fn from(v: Fish) -> ShellEnum

Converts to this type from the input type.

impl From<NuShell> for ShellEnum

fn from(v: NuShell) -> ShellEnum

Converts to this type from the input type.

impl From<PowerShell> for ShellEnum

fn from(v: PowerShell) -> ShellEnum

Converts to this type from the input type.

impl From<Xonsh> for ShellEnum

fn from(v: Xonsh) -> ShellEnum

Converts to this type from the input type.

impl From<Zsh> for ShellEnum

fn from(v: Zsh) -> ShellEnum

Converts to this type from the input type.

impl FromStr for ShellEnum

type Err = ParseShellEnumError

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

fn force_utf8( &self, __enum_dispatch_arg_0: &mut impl Write, ) -> Result<(), ShellError>

Write a command to the script that forces the usage of UTF8-encoding for the shell script.

fn set_env_var( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &str, __enum_dispatch_arg_2: &str, ) -> Result<(), ShellError>

Set an env var by export-ing it.

fn unset_env_var( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &str, ) -> Result<(), ShellError>

Unset an env var by unset-ing it.

fn run_script( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &Path, ) -> Result<(), ShellError>

Run a script in the current shell.

fn source_completions( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &Path, ) -> Result<(), ShellError>

Source completion scripts for the shell from a given prefix path. Note: the completions_dir is the directory where the completions are stored. You can use Self::completion_script_location to get the correct location for a given shell type.

fn can_run_script(&self, __enum_dispatch_arg_0: &Path) -> bool

Test to see if the path can be executed by the shell, based on the extension of the path.

fn run_command<'a>( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: impl IntoIterator<Item = &'a str> + 'a, ) -> Result

Executes a command in the current shell. Use Self::run_script when you want to run another shell script.

fn set_path( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &[PathBuf], __enum_dispatch_arg_2: PathModificationBehavior, __enum_dispatch_arg_3: &Platform, ) -> Result<(), ShellError>

Set the PATH variable to the given paths.

fn extension(&self) -> &str

The extension that shell scripts for this interpreter usually use.

fn executable(&self) -> &str

The executable that can be called to start this shell.

fn create_run_script_command(&self, __enum_dispatch_arg_0: &Path) -> Command

Constructs a Command that will execute the specified script by this shell.

fn path_separator(&self, __enum_dispatch_arg_0: &Platform) -> &str

Path separator

fn path_var(&self, __enum_dispatch_arg_0: &Platform) -> &str

Returns the name of the PATH variable for the given platform. On Windows, path variables are case-insensitive but not all shells treat them case-insensitive.

fn format_env_var(&self, __enum_dispatch_arg_0: &str) -> String

Format the environment variable for the shell.

fn echo( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &str, ) -> Result

Emits echoing certain text to stdout.

fn print_env(&self, __enum_dispatch_arg_0: &mut impl Write) -> Result

Emits writing all current environment variables to stdout.

fn write_script( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &str, ) -> Result<()>

Write the script to the writer and do some post-processing for line-endings. Only really relevant for cmd.exe scripts.

fn parse_env<'i>( &self, __enum_dispatch_arg_0: &'i str, ) -> HashMap<&'i str, &'i str>

Parses environment variables emitted by the Shell::env command.

fn line_ending(&self) -> &str

Get the line ending for this shell. Only CmdExe uses \r\n.

fn completion_script_location(&self) -> Option<&'static Path>

Return the location where completion scripts are found in a Conda environment.

• bash: share/bash-completion/completions
• zsh: share/zsh/site-functions
• fish: share/fish/vendor_completions.d

The return value must be joined with prefix.join(completion_script_location()).

fn restore_env_var( &self, __enum_dispatch_arg_0: &mut impl Write, __enum_dispatch_arg_1: &str, __enum_dispatch_arg_2: &str, ) -> Result<(), ShellError>

Restores an environment variable from its backup if it exists, otherwise unsets it.

Arguments

• key - The name of the environment variable to restore
• backup_key - The name of the backup environment variable

impl TryInto<Bash> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Bash, <Self as TryInto<Bash>>::Error>

Performs the conversion.

impl TryInto<CmdExe> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CmdExe, <Self as TryInto<CmdExe>>::Error>

Performs the conversion.

impl TryInto<Fish> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Fish, <Self as TryInto<Fish>>::Error>

Performs the conversion.

impl TryInto<NuShell> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<NuShell, <Self as TryInto<NuShell>>::Error>

Performs the conversion.

impl TryInto<PowerShell> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<PowerShell, <Self as TryInto<PowerShell>>::Error>

Performs the conversion.

impl TryInto<Xonsh> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Xonsh, <Self as TryInto<Xonsh>>::Error>

Performs the conversion.

impl TryInto<Zsh> for ShellEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Zsh, <Self as TryInto<Zsh>>::Error>

Performs the conversion.