Struct CliTool 

pub struct CliTool { /* private fields */ }

One app’s bundled command-line tool and where to install it.

Implementations

impl CliTool

pub fn new(name: &str, helper: impl Into<PathBuf>) -> Result<Self, CliToolError>

The tool name at helper, installed into SYSTEM_BIN_DIR with ~/.local/bin as the fallback and the OS’s admin prompt; ENV_BIN_DIR / ENV_FALLBACK_DIR override the folders (and turn the prompt off).

pub fn for_current_app(name: &str) -> Result<Self, CliToolError>

CliTool::new with the running app’s bundled_helper.

pub fn bin_dir(self, dir: impl Into<PathBuf>) -> Self

Install into dir instead of the system folder.

pub fn fallback_dir(self, dir: Option<PathBuf>) -> Self

Fall back to dir (None: no fallback, a declined prompt is an error).

pub fn elevation(self, elevation: Elevation) -> Self

pub fn prompt(self, text: impl Into<String>) -> Self

The text shown in the administrator prompt.

pub fn name(&self) -> &str

pub fn helper(&self) -> &Path

pub fn link(&self) -> PathBuf

The link in the system folder.

pub fn helper_present(&self) -> bool

The tool exists in the app.

pub fn state_of(&self, link: &Path) -> LinkState

What link holds.

pub fn status(&self) -> Status

Where the tool is installed: the system link, or the fallback one when the system folder holds nothing and the fallback does.

pub fn install(&self, replace: bool) -> Result<Installed, CliToolError>

Link the tool into the system folder (asking for admin rights when needed), or into the fallback when that is declined. Repairs a stale link. replace allows replacing a file or a link that isn’t ours (never a folder).

pub fn repair(&self) -> Result<Option<Installed>, CliToolError>

Install only when the link is stale (the app moved); otherwise report the status.

pub fn uninstall(&self) -> Result<Removed, CliToolError>

Remove this app’s links (and stale ones) from both folders. Anything else stays.

Trait Implementations

impl Clone for CliTool

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliTool

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

Formats the value using the given formatter.