Struct ActivationReport 

pub struct ActivationReport {
    pub mode: ActivationMode,
    pub availability: Availability,
    pub location: Option<PathBuf>,
    pub reason: Option<String>,
    pub next_step: Option<String>,
}

Structured activation status for an installed completion.

Use this report to decide whether to tell the user “ready now”, “open a new shell”, “source your rc file”, or “finish setup manually”.

Examples

use shellcomp::{ActivationMode, Availability};

let mode = ActivationMode::ManagedRcBlock;
let availability = Availability::AvailableAfterSource;

assert_eq!(mode, ActivationMode::ManagedRcBlock);
assert_eq!(availability, Availability::AvailableAfterSource);

Fields

mode: ActivationMode

Activation mechanism in use.

availability: Availability

Current or expected availability state.

Interpret this together with ActivationReport::mode. For example, ActivationMode::ManagedRcBlock plus Availability::AvailableAfterSource means the completion wiring is present but the current shell session may still need source ~/.bashrc or source ~/.zshrc.

location: Option<PathBuf>

Shell-specific location related to activation.

For system-loader or native-directory activation this is often the completion file path. For managed startup wiring it is typically the startup file path.

reason: Option<String>

Machine-readable operations use enums; this field carries human-readable context.

next_step: Option<String>

Suggested next step for callers to render directly or adapt.

Trait Implementations

impl Clone for ActivationReport

fn clone(&self) -> ActivationReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActivationReport

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

Formats the value using the given formatter.

impl PartialEq for ActivationReport

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

impl StructuralPartialEq for ActivationReport