Struct InstallRequest 

pub struct InstallRequest<'a> {
    pub shell: Shell,
    pub program_name: &'a str,
    pub script: &'a [u8],
    pub path_override: Option<PathBuf>,
}

Input for a completion install operation.

Use path_override when you want to control the destination explicitly. Non-default custom paths normally require caller-managed activation unless you opt into crate::install_with_policy with ActivationPolicy::AutoManaged.

Fields

shell: Shell

Target shell.

program_name: &'a str

Binary name used by the completion script.

The name must be non-empty and use a portable ASCII character set consisting of letters, digits, ., _, and -.

script: &'a [u8]

Completion script bytes to install.

path_override: Option<PathBuf>

Optional explicit install path instead of the managed default path.

Legacy crate::install behavior treats non-default custom paths as manual activation. When this path exactly matches the shell’s managed default location, the usual managed or native activation semantics are preserved instead.

Trait Implementations

impl<'a> Clone for InstallRequest<'a>

fn clone(&self) -> InstallRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InstallRequest<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for InstallRequest<'a>

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

impl<'a> StructuralPartialEq for InstallRequest<'a>