pub struct VxEnvironment { /* private fields */ }Expand description
VX environment manager
Implementations§
Source§impl VxEnvironment
impl VxEnvironment
Sourcepub fn new_with_base_dir<P: AsRef<Path>>(base_dir: P) -> Result<Self>
pub fn new_with_base_dir<P: AsRef<Path>>(base_dir: P) -> Result<Self>
Create a new VX environment with custom base directory (for testing)
Sourcepub fn get_vx_home() -> Result<PathBuf>
pub fn get_vx_home() -> Result<PathBuf>
Get VX home directory
Sourcepub fn get_base_install_dir(&self) -> PathBuf
pub fn get_base_install_dir(&self) -> PathBuf
Get base installation directory
Sourcepub fn get_tool_install_dir(&self, tool_name: &str) -> PathBuf
pub fn get_tool_install_dir(&self, tool_name: &str) -> PathBuf
Get tool installation directory
Sourcepub fn get_version_install_dir(&self, tool_name: &str, version: &str) -> PathBuf
pub fn get_version_install_dir(&self, tool_name: &str, version: &str) -> PathBuf
Get version installation directory
Sourcepub fn get_cache_dir(&self) -> PathBuf
pub fn get_cache_dir(&self) -> PathBuf
Get cache directory for downloads
Sourcepub fn get_tool_cache_dir(&self, tool_name: &str) -> PathBuf
pub fn get_tool_cache_dir(&self, tool_name: &str) -> PathBuf
Get download cache directory for a tool
Sourcepub fn get_config_file(&self) -> PathBuf
pub fn get_config_file(&self) -> PathBuf
Get configuration file path
Sourcepub fn load_config(&self) -> Result<EnvironmentConfig>
pub fn load_config(&self) -> Result<EnvironmentConfig>
Load environment configuration
Sourcepub fn save_config(&self, config: &EnvironmentConfig) -> Result<()>
pub fn save_config(&self, config: &EnvironmentConfig) -> Result<()>
Save environment configuration
Sourcepub fn get_active_version(&self, tool_name: &str) -> Result<Option<String>>
pub fn get_active_version(&self, tool_name: &str) -> Result<Option<String>>
Get active version for a tool
Sourcepub fn set_active_version(&self, tool_name: &str, version: &str) -> Result<()>
pub fn set_active_version(&self, tool_name: &str, version: &str) -> Result<()>
Set active version for a tool
Sourcepub fn list_installed_versions(&self, tool_name: &str) -> Result<Vec<String>>
pub fn list_installed_versions(&self, tool_name: &str) -> Result<Vec<String>>
List all installed versions for a tool
Sourcepub fn is_version_installed(&self, tool_name: &str, version: &str) -> bool
pub fn is_version_installed(&self, tool_name: &str, version: &str) -> bool
Check if a version is installed
Sourcepub fn get_installation_info(
&self,
tool_name: &str,
version: &str,
) -> Result<Option<ToolInstallation>>
pub fn get_installation_info( &self, tool_name: &str, version: &str, ) -> Result<Option<ToolInstallation>>
Get installation info for a tool version
Sourcepub fn find_executable_in_dir(
&self,
dir: &Path,
tool_name: &str,
) -> Result<PathBuf>
pub fn find_executable_in_dir( &self, dir: &Path, tool_name: &str, ) -> Result<PathBuf>
Find executable in installation directory
Trait Implementations§
Source§impl Clone for VxEnvironment
impl Clone for VxEnvironment
Source§fn clone(&self) -> VxEnvironment
fn clone(&self) -> VxEnvironment
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for VxEnvironment
impl Debug for VxEnvironment
Auto Trait Implementations§
impl Freeze for VxEnvironment
impl RefUnwindSafe for VxEnvironment
impl Send for VxEnvironment
impl Sync for VxEnvironment
impl Unpin for VxEnvironment
impl UnwindSafe for VxEnvironment
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);