Struct InstallReport 

pub struct InstallReport {
    pub shell: Shell,
    pub target_path: PathBuf,
    pub file_change: FileChange,
    pub activation: ActivationReport,
    pub affected_locations: Vec<PathBuf>,
}

Structured result of a completion install operation.

The report is designed for caller-side rendering. shellcomp does not print user-facing output directly.

Fields

shell: Shell

Target shell.

target_path: PathBuf

Final script path that was written.

file_change: FileChange

Outcome of writing the completion file.

This only describes the completion script file itself. Startup wiring state is described by InstallReport::activation.

activation: ActivationReport

Activation details for the installed completion.

affected_locations: Vec<PathBuf>

Files touched or referenced while completing the operation.

This includes InstallReport::target_path and may also include a managed shell startup file such as ~/.bashrc or ~/.zshrc.

Trait Implementations

impl Clone for InstallReport

fn clone(&self) -> InstallReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstallReport

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

Formats the value using the given formatter.

impl PartialEq for InstallReport

fn eq(&self, other: &InstallReport) -> 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 Eq for InstallReport

impl StructuralPartialEq for InstallReport