Function uninstall 

pub fn uninstall(request: UninstallRequest<'_>) -> Result<RemoveReport>

Removes a previously managed completion script and any managed activation wiring.

When path_override is set, legacy behavior removes only that file path for non-default custom targets. If the override is equal to the shell’s managed default path, uninstall keeps the default cleanup semantics for that shell.

This function is idempotent. Removing an already absent completion file returns crate::FileChange::Absent rather than failing.

Errors

Returns crate::Error::Failure for structured operational failures such as unresolved managed paths or unwritable shell profile files.

Examples

use shellcomp::{Shell, UninstallRequest, uninstall};

let report = uninstall(UninstallRequest {
    shell: Shell::Bash,
    program_name: "demo",
    path_override: None,
})?;

assert_eq!(report.shell, Shell::Bash);

Examples found in repository

examples/roundtrip_custom_path.rs (lines 16-20)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let demo_path = env::temp_dir().join(format!("demo-roundtrip-{}.fish", std::process::id()));
    let script = b"complete -c demo -f\n";

    let install_report = install(InstallRequest {
        shell: Shell::Fish,
        program_name: "demo",
        script,
        path_override: Some(demo_path.clone()),
    })?;

    let uninstall_report = uninstall(UninstallRequest {
        shell: Shell::Fish,
        program_name: "demo",
        path_override: Some(demo_path.clone()),
    })?;

    println!("Installed and removed a custom-path completion file.");
    println!("Path: {}", demo_path.display());
    println!("Install report:\n{install_report:#?}");
    println!("Uninstall report:\n{uninstall_report:#?}");
    Ok(())
}