Struct Shell 

pub struct Shell { /* private fields */ }

Information about the detected shell.

Implementations

impl Shell

pub fn detect() -> Result<Self>

Errors

Returns an error if the parent process chain cannot be read or if no known shell is found within the hop limit.

Examples found in repository

examples/basic.rs (line 4)

fn main() -> std::io::Result<()> {
    let shell = Shell::detect()?;
    let name = shell.name();
    let ver = shell.version().unwrap_or_else(|| "unknown".to_string());
    println!("{name} {ver}");
    Ok(())
}

pub fn name(&self) -> &str

Returns the detected shell name.

Examples found in repository

examples/basic.rs (line 5)

fn main() -> std::io::Result<()> {
    let shell = Shell::detect()?;
    let name = shell.name();
    let ver = shell.version().unwrap_or_else(|| "unknown".to_string());
    println!("{name} {ver}");
    Ok(())
}

pub fn version(&self) -> Option<String>

Returns the detected shell version, if available.

Examples found in repository

examples/basic.rs (line 6)

fn main() -> std::io::Result<()> {
    let shell = Shell::detect()?;
    let name = shell.name();
    let ver = shell.version().unwrap_or_else(|| "unknown".to_string());
    println!("{name} {ver}");
    Ok(())
}

pub const fn supported_shells() -> &'static [&'static str]

Returns the list of supported shell names.

Trait Implementations

impl Debug for Shell

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

Formats the value using the given formatter.