Struct proto::Tool

pub struct Tool {
    pub id: Id,
    pub manifest: ToolManifest,
    pub metadata: ToolMetadataOutput,
    pub plugin: PluginContainer<'static>,
    pub proto: ProtoEnvironment,
    pub version: Option<AliasOrVersion>,
    /* private fields */
}

Fields

id: Id

manifest: ToolManifest

metadata: ToolMetadataOutput

plugin: PluginContainer<'static>

proto: ProtoEnvironment

version: Option<AliasOrVersion>

Implementations

impl Tool

pub fn load<I, P>(id: I, proto: P, wasm: Wasm) -> Result<Tool, Report>where I: AsRef<Id>, P: AsRef<ProtoEnvironment>,

pub fn load_from_manifest<I, P>( id: I, proto: P, manifest: Manifest ) -> Result<Tool, Report>where I: AsRef<Id>, P: AsRef<ProtoEnvironment>,

pub fn create_plugin_manifest<P>( proto: P, wasm: Wasm ) -> Result<Manifest, Report>where P: AsRef<ProtoEnvironment>,

pub fn get_bin_path(&self) -> Result<&Path, Report>

Return an absolute path to the executable binary for the tool.

pub fn get_env_var_prefix(&self) -> String

Return the prefix for environment variable names.

pub fn get_globals_bin_dir(&self) -> Option<&Path>

Return an absolute path to the globals directory in which packages are installed to.

pub fn get_globals_prefix(&self) -> Option<&str>

Return a string that all globals are prefixed with. Will be used for filtering and listing.

pub fn get_inventory_dir(&self) -> PathBuf

Return an absolute path to the tool’s inventory directory. The inventory houses installed versions, the manifest, and more.

pub fn get_name(&self) -> &str

Return a human readable name for the tool.

pub fn get_resolved_version(&self) -> AliasOrVersion

Return the resolved version or “latest”.

pub fn get_shim_path(&self) -> Option<PathBuf>

Return a path to a local shim file if it exists.

pub fn get_temp_dir(&self) -> PathBuf

Return an absolute path to a temp directory solely for this tool.

pub fn get_tool_dir(&self) -> PathBuf

Return an absolute path to the tool’s install directory for the currently resolved version.

pub fn set_version(&mut self, version: AliasOrVersion)

Explicitly set the version to use.

pub fn disable_progress_bars(&self) -> bool

Disable progress bars when installing or uninstalling the tool.

impl Tool

pub fn create_environment(&self) -> Result<Environment, Report>

Return environment information to pass to WASM plugin functions.

pub fn register_tool(&mut self) -> Result<(), Report>

Register the tool by loading initial metadata and persisting it.

pub fn sync_manifest(&mut self) -> Result<(), Report>

Sync the local tool manifest with changes from the plugin.

impl Tool

pub async fn load_version_resolver( &self, initial_version: &VersionType ) -> impl Future<Output = Result<VersionResolver<'_>, Report>>

Load available versions to install and return a resolver instance. To reduce network overhead, results will be cached for 24 hours.

pub async fn resolve_version( &mut self, initial_version: &VersionType ) -> impl Future<Output = Result<(), Report>>

Given an initial version, resolve it to a fully qualifed and semantic version (or alias) according to the tool’s ecosystem.

impl Tool

pub async fn detect_version_from( &self, current_dir: &Path ) -> impl Future<Output = Result<Option<VersionType>, Report>>

Attempt to detect an applicable version from the provided directory.

impl Tool

pub async fn verify_checksum( &self, checksum_file: &Path, download_file: &Path ) -> impl Future<Output = Result<bool, Report>>

Verify the downloaded file using the checksum strategy for the tool. Common strategies are SHA256 and MD5.

pub async fn install_from_prebuilt( &self, install_dir: &Path ) -> impl Future<Output = Result<PathBuf, Report>>

Download the tool (as an archive) from its distribution registry into the ~/.proto/temp folder, and optionally verify checksums.

pub async fn install(&mut self) -> impl Future<Output = Result<bool, Report>>

Install a tool into proto, either by downloading and unpacking a pre-built archive, or by using a native installation method.

pub async fn uninstall(&self) -> impl Future<Output = Result<bool, Report>>

Uninstall the tool by deleting the current install directory.

pub async fn locate_bins(&mut self) -> impl Future<Output = Result<(), Report>>

Find the absolute file path to the tool’s binary that will be executed.

pub async fn locate_globals_dir( &mut self ) -> impl Future<Output = Result<(), Report>>

Find the directory global packages are installed to.

impl Tool

pub fn create_shim_context(&self) -> ShimContext<'_>

Create the context object required for creating shim files.

pub async fn create_shims( &self, find_only: bool ) -> impl Future<Output = Result<(), Report>>

Create global and local shim files for the current tool. If find only is enabled, will only check if they exist, and not create.

impl Tool

pub async fn is_setup( &mut self, initial_version: &VersionType ) -> impl Future<Output = Result<bool, Report>>

Return true if the tool has been setup (installed and binaries are located).

pub async fn setup( &mut self, initial_version: &VersionType ) -> impl Future<Output = Result<bool, Report>>

Setup the tool by resolving a semantic version, installing the tool, locating binaries, creating shims, and more.

pub async fn setup_shims( &mut self, force: bool ) -> impl Future<Output = Result<(), Report>>

Setup shims if they are missing or out of date.

pub async fn teardown(&mut self) -> impl Future<Output = Result<bool, Report>>

Teardown the tool by uninstalling the current version, removing the version from the manifest, and cleaning up temporary files. Return true if the teardown occurred.

pub async fn cleanup(&mut self) -> impl Future<Output = Result<(), Report>>

Delete temporary files and downloads for the current version.