Struct proto_node::NodeLanguage
source · pub struct NodeLanguage {
pub base_dir: PathBuf,
pub bin_path: Option<PathBuf>,
pub shim_path: Option<PathBuf>,
pub temp_dir: PathBuf,
pub version: Option<String>,
/* private fields */
}
Fields§
§base_dir: PathBuf
§bin_path: Option<PathBuf>
§shim_path: Option<PathBuf>
§temp_dir: PathBuf
§version: Option<String>
Implementations§
Trait Implementations§
source§impl Debug for NodeLanguage
impl Debug for NodeLanguage
source§impl Describable<'_> for NodeLanguage
impl Describable<'_> for NodeLanguage
source§impl Detector<'_> for NodeLanguage
impl Detector<'_> for NodeLanguage
source§fn detect_version_from<'life0, 'life1, 'async_trait>(
&'life0 self,
working_dir: &'life1 Path
) -> Pin<Box<dyn Future<Output = Result<Option<String>, ProtoError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn detect_version_from<'life0, 'life1, 'async_trait>( &'life0 self, working_dir: &'life1 Path ) -> Pin<Box<dyn Future<Output = Result<Option<String>, ProtoError>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
Attempt to detect an applicable version from the provided working directory.
source§impl Downloadable<'_> for NodeLanguage
impl Downloadable<'_> for NodeLanguage
source§fn get_download_path(&self) -> Result<PathBuf, ProtoError>
fn get_download_path(&self) -> Result<PathBuf, ProtoError>
Return an absolute file path to the downloaded file.
This may not exist, as the path is composed ahead of time.
This is typically
~/.proto/temp/<file>
.source§fn get_download_url(&self) -> Result<String, ProtoError>
fn get_download_url(&self) -> Result<String, ProtoError>
Return a URL to download the tool’s archive from a registry.
source§fn download<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
to_file: &'life1 Path,
from_url: Option<&'life2 str>
) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: 'async_trait,
fn download<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, to_file: &'life1 Path, from_url: Option<&'life2 str> ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,
Download the tool (as an archive) from its distribution registry
into the
~/.proto/temp
folder and return an absolute file path.
A custom URL that points to the downloadable archive can be
provided as the 2nd argument.source§impl Executable<'_> for NodeLanguage
impl Executable<'_> for NodeLanguage
source§fn find_bin_path<'life0, 'async_trait>(
&'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn find_bin_path<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Find the absolute file path to the tool’s binary that will be executed.
This happens after a tool has been downloaded and installed.
source§fn get_bin_path(&self) -> Result<&Path, ProtoError>
fn get_bin_path(&self) -> Result<&Path, ProtoError>
Return an absolute file path to the executable binary for the tool.
source§fn get_globals_bin_dir(&self) -> Result<Option<PathBuf>, ProtoError>
fn get_globals_bin_dir(&self) -> Result<Option<PathBuf>, ProtoError>
Return an absolute file path to the directory containing all
globally installed packages.
source§impl Installable<'_> for NodeLanguage
impl Installable<'_> for NodeLanguage
source§fn get_archive_prefix(&self) -> Result<Option<String>, ProtoError>
fn get_archive_prefix(&self) -> Result<Option<String>, ProtoError>
Return a prefix that will be removed from all paths when
unpacking an archive and copying the files.
source§fn get_install_dir(&self) -> Result<PathBuf, ProtoError>
fn get_install_dir(&self) -> Result<PathBuf, ProtoError>
Return an absolute file path to the directory containing the installed tool.
This is typically
~/.proto/tools/<tool>/<version>
.source§fn install<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
install_dir: &'life1 Path,
download_path: &'life2 Path
) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: 'async_trait,
fn install<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, install_dir: &'life1 Path, download_path: &'life2 Path ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,
Run any installation steps after downloading and verifying the tool.
This is typically unzipping an archive, and running any installers/binaries.
source§fn should_unpack(&self) -> bool
fn should_unpack(&self) -> bool
Whether or not the downloaded file should be unpacked before installing.
source§fn uninstall<'life0, 'life1, 'async_trait>(
&'life0 self,
install_dir: &'life1 Path
) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn uninstall<'life0, 'life1, 'async_trait>( &'life0 self, install_dir: &'life1 Path ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,
Uninstall the tool by deleting the install directory.
source§impl Resolvable<'_> for NodeLanguage
impl Resolvable<'_> for NodeLanguage
source§fn get_resolved_version(&self) -> &str
fn get_resolved_version(&self) -> &str
Return the resolved version.
source§fn load_version_manifest<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<VersionManifest, ProtoError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn load_version_manifest<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<VersionManifest, ProtoError>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Load the upstream version and release manifest.
source§fn resolve_version<'life0, 'life1, 'async_trait>(
&'life0 mut self,
initial_version: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<String, ProtoError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn resolve_version<'life0, 'life1, 'async_trait>( &'life0 mut self, initial_version: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<String, ProtoError>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
Given an initial version, resolve it to a fully qualifed and semantic version
according to the tool’s ecosystem.
source§fn set_version(&mut self, version: &str)
fn set_version(&mut self, version: &str)
Explicitly set the resolved version.
source§fn get_default_version(&self) -> Option<&str>
fn get_default_version(&self) -> Option<&str>
Return the version to be used as the global default.
source§impl Shimable<'_> for NodeLanguage
impl Shimable<'_> for NodeLanguage
source§fn create_shims<'life0, 'async_trait>(
&'life0 mut self,
find_only: bool
) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn create_shims<'life0, 'async_trait>( &'life0 mut self, find_only: bool ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Create one or many shims in the root of the tool’s install directory.
source§fn get_shim_path(&self) -> Option<&Path>
fn get_shim_path(&self) -> Option<&Path>
Return an absolute path to the shim file if utilizing shims.
source§impl Tool<'_> for NodeLanguage
impl Tool<'_> for NodeLanguage
fn as_any(&self) -> &dyn Any
fn get_manifest(&self) -> Result<&Manifest, ProtoError>
fn get_manifest_mut(&mut self) -> Result<&mut Manifest, ProtoError>
fn get_tool_dir(&self) -> &Path
fn get_manifest_path(&self) -> PathBuf
fn before_setup<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
fn setup<'life0, 'life1, 'async_trait>( &'life0 mut self, initial_version: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,
fn setup_shims<'life0, 'async_trait>( &'life0 mut self, force: bool ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
fn is_setup<'life0, 'life1, 'async_trait>( &'life0 mut self, initial_version: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,
fn after_setup<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
fn cleanup<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
fn before_teardown<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
fn teardown<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
fn after_teardown<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, Self: 'async_trait,
source§impl Verifiable<'_> for NodeLanguage
impl Verifiable<'_> for NodeLanguage
source§fn get_checksum_path(&self) -> Result<PathBuf, ProtoError>
fn get_checksum_path(&self) -> Result<PathBuf, ProtoError>
Return an absolute file path to the checksum file.
This may not exist, as the path is composed ahead of time.
This is typically
~/.proto/temp/<file>
.source§fn get_checksum_url(&self) -> Result<Option<String>, ProtoError>
fn get_checksum_url(&self) -> Result<Option<String>, ProtoError>
Return a URL to download the tool’s checksum manifest from a registry.
source§fn verify_checksum<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
checksum_file: &'life1 Path,
download_file: &'life2 Path
) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn verify_checksum<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, checksum_file: &'life1 Path, download_file: &'life2 Path ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,
Verify the downloaded file using the checksum strategy for the tool.
Common strategies are SHA256 and MD5.
source§fn download_checksum<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
to_file: &'life1 Path,
from_url: Option<&'life2 str>
) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: 'async_trait,
fn download_checksum<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, to_file: &'life1 Path, from_url: Option<&'life2 str> ) -> Pin<Box<dyn Future<Output = Result<bool, ProtoError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,
If applicable, download all files necessary for verifying checksums.
Auto Trait Implementations§
impl RefUnwindSafe for NodeLanguage
impl Send for NodeLanguage
impl Sync for NodeLanguage
impl Unpin for NodeLanguage
impl UnwindSafe for NodeLanguage
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
Mutably borrows from an owned value. Read more
§impl<T> GetSetFdFlags for T
impl<T> GetSetFdFlags for T
§fn get_fd_flags(&self) -> Result<FdFlags, Error>where
T: AsFilelike,
fn get_fd_flags(&self) -> Result<FdFlags, Error>where T: AsFilelike,
Query the “status” flags for the
self
file descriptor.§fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>where
T: AsFilelike,
fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>where T: AsFilelike,
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>
§impl<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,
Set the foreground color generically Read more
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,
Set the background color generically. Read more
§fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
Change the background color to yellow
§fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
Change the foreground color to magenta
§fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
Change the background color to magenta
§fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
Change the background color to purple
§fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>
fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>
Change the foreground color to the terminal default
§fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>
fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>
Change the background color to the terminal default
§fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
Change the foreground color to bright black
§fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
Change the background color to bright black
§fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
Change the foreground color to bright red
§fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
Change the background color to bright red
§fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
Change the foreground color to bright green
§fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
Change the background color to bright green
§fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
Change the foreground color to bright yellow
§fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
Change the background color to bright yellow
§fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
Change the foreground color to bright blue
§fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
Change the background color to bright blue
§fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
Change the foreground color to bright magenta
§fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
Change the background color to bright magenta
§fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
Change the foreground color to bright purple
§fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
Change the background color to bright purple
§fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
Change the foreground color to bright cyan
§fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
Change the background color to bright cyan
§fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
Change the foreground color to bright white
§fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
Change the background color to bright white
§fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
Make the text blink (but fast!)
Hide the text
§fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
Cross out the text
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.