pub struct ConfigOverrides {Show 15 fields
pub config_file: Option<PathBuf>,
pub system_config_dir: Option<PathBuf>,
pub app_dir: Option<PathBuf>,
pub user_config_dir: Option<PathBuf>,
pub http_timeout: Option<String>,
pub http_retries: Option<usize>,
pub http_proxy: Option<String>,
pub lockfile: LockMode,
pub offline: bool,
pub refresh: bool,
pub prebuilt_binary: Option<UsePrebuiltBinaries>,
pub prebuilt_binary_sources: Option<Vec<BinaryProvider>>,
pub prebuilt_binary_no_verify_checksums: bool,
pub prebuilt_binary_no_verify_signatures: bool,
pub verbosity: Verbosity,
}Expand description
Configuration overrides supplied on the command line.
This is the config-layer input to Config::load: it carries the subset of parsed arguments
that influence configuration loading. This is meant to be populated from the CLI arguments,
without coupling this layer to the actual CLI or clap.
Fields§
§config_file: Option<PathBuf>Read configuration from this TOML file only, bypassing the usual search paths
(--config-file).
system_config_dir: Option<PathBuf>Override the system config directory location (--system-config-dir).
app_dir: Option<PathBuf>Override the base application directory (--app-dir).
user_config_dir: Option<PathBuf>Override the user config directory location (--user-config-dir).
http_timeout: Option<String>HTTP request timeout as a raw string (e.g. "30s", "2m"), parsed by Config
(--http-timeout).
http_retries: Option<usize>Maximum number of retries for transient HTTP failures (--http-retries).
http_proxy: Option<String>HTTP or SOCKS5 proxy URL for all HTTP requests (--http-proxy).
lockfile: LockModeHow the lockfile should be treated (--locked/--frozen/--unlocked).
offline: boolRun without accessing the network (--offline); combines with Self::lockfile.
refresh: boolForce refresh of all cached data for this crate (--refresh).
prebuilt_binary: Option<UsePrebuiltBinaries>Control use of pre-built binaries: never, always, or auto (--prebuilt-binary).
prebuilt_binary_sources: Option<Vec<BinaryProvider>>Override the binary providers to check for pre-built binaries (--prebuilt-binary-sources).
prebuilt_binary_no_verify_checksums: boolDisable checksum verification when downloading pre-built binaries
(--prebuilt-binary-no-verify-checksums).
prebuilt_binary_no_verify_signatures: boolDisable signature verification when downloading pre-built binaries
(--prebuilt-binary-no-verify-signatures).
verbosity: VerbosityLogging/build verbosity from the repeated -v flag.
Trait Implementations§
Source§impl Clone for ConfigOverrides
impl Clone for ConfigOverrides
Source§fn clone(&self) -> ConfigOverrides
fn clone(&self) -> ConfigOverrides
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ConfigOverrides
impl Debug for ConfigOverrides
Source§impl Default for ConfigOverrides
impl Default for ConfigOverrides
Source§fn default() -> ConfigOverrides
fn default() -> ConfigOverrides
Auto Trait Implementations§
impl Freeze for ConfigOverrides
impl RefUnwindSafe for ConfigOverrides
impl Send for ConfigOverrides
impl Sync for ConfigOverrides
impl Unpin for ConfigOverrides
impl UnsafeUnpin for ConfigOverrides
impl UnwindSafe for ConfigOverrides
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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§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>
renamed to 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);