Function detect_activation 

pub fn detect_activation(
    shell: Shell,
    program_name: &str,
) -> Result<ActivationReport>

Detects how a completion would be activated for the current environment.

Detection inspects the default managed location for the given shell and binary name. For custom paths, use detect_activation_at_path.

The returned crate::ActivationReport distinguishes the wiring mechanism (crate::ActivationMode) from current readiness (crate::Availability).

Errors

Returns crate::Error::Failure when the managed path or startup wiring cannot be inspected safely.

Examples

use shellcomp::{Shell, detect_activation};

let report = detect_activation(Shell::Fish, "demo")?;
println!("{report:#?}");

Examples found in repository

examples/inspect_managed_paths.rs (line 6)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    for shell in [Shell::Bash, Shell::Zsh, Shell::Fish] {
        let path = default_install_path(shell.clone(), "demo")?;
        let activation = detect_activation(shell.clone(), "demo")?;

        println!("Shell: {shell}");
        println!("Managed path: {}", path.display());
        println!("Activation: {activation:#?}");
        println!();
    }

    Ok(())
}