pub struct ShimConfig {
pub shim: ShimCore,
pub args: ArgsConfig,
pub env: HashMap<String, String>,
pub metadata: ShimMetadata,
pub auto_update: Option<AutoUpdate>,
}Expand description
Main shim configuration structure
Fields§
§shim: ShimCoreCore shim configuration
args: ArgsConfigAdvanced argument configuration
env: HashMap<String, String>Environment variables to set
metadata: ShimMetadataOptional metadata
auto_update: Option<AutoUpdate>Auto-update configuration
Implementations§
Source§impl ShimConfig
impl ShimConfig
Sourcepub fn new(name: impl Into<String>, path: impl Into<String>) -> Self
pub fn new(name: impl Into<String>, path: impl Into<String>) -> Self
Create a new shim configuration with minimal required fields
Sourcepub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>
pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>
Load shim configuration from a TOML file
Sourcepub async fn from_file_async<P: AsRef<Path>>(path: P) -> Result<Self>
pub async fn from_file_async<P: AsRef<Path>>(path: P) -> Result<Self>
Load shim configuration from a TOML file asynchronously
Sourcepub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>
pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>
Save shim configuration to a TOML file
Sourcepub async fn to_file_async<P: AsRef<Path>>(&self, path: P) -> Result<()>
pub async fn to_file_async<P: AsRef<Path>>(&self, path: P) -> Result<()>
Save shim configuration to a TOML file asynchronously
Sourcepub async fn from_files_concurrent<P: AsRef<Path>>(
paths: Vec<P>,
) -> Vec<Result<Self>> ⓘ
pub async fn from_files_concurrent<P: AsRef<Path>>( paths: Vec<P>, ) -> Vec<Result<Self>> ⓘ
Load multiple configuration files concurrently
Sourcepub async fn to_files_concurrent<P: AsRef<Path>>(
configs_and_paths: Vec<(&Self, P)>,
) -> Vec<Result<()>> ⓘ
pub async fn to_files_concurrent<P: AsRef<Path>>( configs_and_paths: Vec<(&Self, P)>, ) -> Vec<Result<()>> ⓘ
Save multiple configurations concurrently
Sourcepub fn expand_env_vars(&mut self) -> Result<()>
pub fn expand_env_vars(&mut self) -> Result<()>
Expand environment variables in the configuration
Sourcepub fn get_executable_path(&self) -> Result<PathBuf>
pub fn get_executable_path(&self) -> Result<PathBuf>
Get the resolved executable path
Sourcepub fn get_download_url(&self) -> Option<&String>
pub fn get_download_url(&self) -> Option<&String>
Get the download URL for this shim (if it was created from HTTP)
Trait Implementations§
Source§impl Clone for ShimConfig
impl Clone for ShimConfig
Source§fn clone(&self) -> ShimConfig
fn clone(&self) -> ShimConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ShimConfig
impl Debug for ShimConfig
Source§impl<'de> Deserialize<'de> for ShimConfig
impl<'de> Deserialize<'de> for ShimConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for ShimConfig
impl RefUnwindSafe for ShimConfig
impl Send for ShimConfig
impl Sync for ShimConfig
impl Unpin for ShimConfig
impl UnwindSafe for ShimConfig
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);