Skip to main content

InstallOptions

Struct InstallOptions 

Source
pub struct InstallOptions {
    pub agents: Vec<AgentSelector>,
    pub scope: Option<Scope>,
    pub dir: Option<PathBuf>,
    pub force: bool,
    pub dry_run: bool,
    pub names: Vec<String>,
    pub cancel: Option<Arc<AtomicBool>>,
}
Expand description

The inputs shared by install, uninstall and list.

Every field has a default, so a caller names only what it means to change:

use skill_embed::{Agent, AgentSelector, InstallOptions, Scope};

let options = InstallOptions {
    agents: vec![AgentSelector::from(&Agent::CLAUDE_CODE)],
    scope: Some(Scope::User),
    ..InstallOptions::default()
};

Fields§

§agents: Vec<AgentSelector>

Selects the destinations. Empty means the installer default.

§scope: Option<Scope>

None means the installer default.

§dir: Option<PathBuf>

Installs into this directory, overriding agents and scope.

§force: bool

Overwrites skills that were edited, or that something else installed.

§dry_run: bool

Reports what would happen without touching the file system.

§names: Vec<String>

Selects skills by name. Empty means every embedded skill.

§cancel: Option<Arc<AtomicBool>>

Stops the run between skills once it is set.

A single skill is written whole or not at all, so the flag is read between them rather than during one.

Trait Implementations§

Source§

impl Clone for InstallOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InstallOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for InstallOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.