Struct InstalledTools 

pub struct InstalledTools { /* private fields */ }

A collection of uv-managed tools installed on the current system.

Implementations

impl InstalledTools

pub fn from_settings() -> Result<Self, Error>

Create a new InstalledTools from settings.

Prefer, in order:

1. The specific tool directory specified by the user, i.e., UV_TOOL_DIR
2. A directory in the system-appropriate user-level data directory, e.g., ~/.local/uv/tools
3. A directory in the local data directory, e.g., ./.uv/tools

pub fn tool_dir(&self, name: &PackageName) -> PathBuf

Return the expected directory for a tool with the given PackageName.

pub fn tools(&self) -> Result<Vec<(PackageName, Result<Tool, Error>)>, Error>

Return the metadata for all installed tools.

If a tool is present, but is missing a receipt or the receipt is invalid, the tool will be included with an error.

Note it is generally incorrect to use this without [Self::acquire_lock].

pub fn get_tool_receipt( &self, name: &PackageName, ) -> Result<Option<Tool>, Error>

Get the receipt for the given tool.

If the tool is not installed, returns Ok(None). If the receipt is invalid, returns an error.

Note it is generally incorrect to use this without [Self::acquire_lock].

pub async fn lock(&self) -> Result<LockedFile, Error>

Grab a file lock for the tools directory to prevent concurrent access across processes.

pub fn add_tool_receipt( &self, name: &PackageName, tool: Tool, ) -> Result<(), Error>

Add a receipt for a tool.

Any existing receipt will be replaced.

Note it is generally incorrect to use this without [Self::acquire_lock].

pub fn remove_environment(&self, name: &PackageName) -> Result<(), Error>

Remove the environment for a tool.

Does not remove the tool’s entrypoints.

Note it is generally incorrect to use this without [Self::acquire_lock].

Errors

If no such environment exists for the tool.

pub fn get_environment( &self, name: &PackageName, cache: &Cache, ) -> Result<Option<ToolEnvironment>, Error>

Return the PythonEnvironment for a given tool, if it exists.

Returns Ok(None) if the environment does not exist or is linked to a non-existent interpreter.

Note it is generally incorrect to use this without [Self::acquire_lock].

pub fn create_environment( &self, name: &PackageName, interpreter: Interpreter, preview: Preview, ) -> Result<PythonEnvironment, Error>

Create the PythonEnvironment for a given tool, removing any existing environments.

Note it is generally incorrect to use this without [Self::acquire_lock].

pub fn temp() -> Result<Self, Error>

Create a temporary tools directory.

pub fn init(self) -> Result<Self, Error>

Initialize the tools directory.

Ensures the directory is created.

pub fn root(&self) -> &Path

Return the path of the tools directory.

Trait Implementations

impl Clone for InstalledTools

fn clone(&self) -> InstalledTools

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstalledTools

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

Formats the value using the given formatter.