pub struct Config {Show 16 fields
pub config_dir: PathBuf,
pub cache_dir: PathBuf,
pub bin_dir: PathBuf,
pub build_dir: PathBuf,
pub resolve_cache_timeout: Duration,
pub offline: bool,
pub locked: bool,
pub refresh: bool,
pub toolchain: Option<String>,
pub log_level: Option<String>,
pub verbosity: Verbosity,
pub default_registry: Option<String>,
pub prebuilt_binaries: PrebuiltBinariesConfig,
pub http: HttpConfig,
pub tools: HashMap<String, ToolConfig>,
pub aliases: HashMap<String, String>,
}Expand description
Configuration settings for cgx.
Configuration is loaded from multiple sources in order of precedence (later sources override earlier ones):
- Hard-coded defaults
- System-wide config file (
/etc/cgx.tomlon Linux/macOS) - User config file (
$XDG_CONFIG_HOME/cgx/cgx.tomlor platform equivalent) - Directory hierarchy from filesystem root to current directory (each
cgx.tomlfound) - Command-line arguments (highest priority)
Fields§
§config_dir: PathBufDirectory where config files are stored
cache_dir: PathBufThe cache directory where various levels of cache are located
bin_dir: PathBufDirectory where compiled binaries that can be re-used are stored
build_dir: PathBufDirectory for ephemeral build artifacts.
Temporary directories for source extraction and compilation are created here. Only the final compiled binary is retained; all other build artifacts are cleaned up.
resolve_cache_timeout: DurationHow long to keep resolved crate information in the cache before re-resolving
offline: bool§locked: bool§refresh: bool§toolchain: Option<String>Rust toolchain to use for building (e.g., “nightly”, “1.70.0”, “stable”)
log_level: Option<String>Logging filter expression from the config file (e.g., “info”, “debug”, “cgx=debug,info”).
verbosity: VerbosityLogging/build verbosity from the repeated -v CLI flag.
The single source from which both the tracing level and cargo’s -v count are derived.
default_registry: Option<String>Default registry to use instead of crates.io when no registry is explicitly specified
prebuilt_binaries: PrebuiltBinariesConfigHow or whether to look for pre-built binaries published for the crates being run.
http: HttpConfigHTTP client configuration for registry queries, binary downloads, and API calls.
tools: HashMap<String, ToolConfig>Pinned tool versions and configurations.
Tools listed here will use the specified version/source instead of being resolved dynamically. This allows pinning critical tools to specific versions.
aliases: HashMap<String, String>Tool name aliases.
Maps convenient names to actual crate names. For example, rg -> ripgrep.
Note that aliases shadow actual crate names, so aliased crates become inaccessible.
Implementations§
Source§impl Config
impl Config
Sourcepub fn load(overrides: &ConfigOverrides) -> Result<Self>
pub fn load(overrides: &ConfigOverrides) -> Result<Self>
Load the configuration, honoring config files and command line arguments.
Configuration is loaded from multiple sources with the following precedence (later sources override earlier ones):
- Hard-coded defaults
- System-wide config file
- User config file
- Directory hierarchy config files (from root to current directory)
- Command-line arguments (highest priority)
Sourcepub fn tools_toml(&self) -> Result<String>
pub fn tools_toml(&self) -> Result<String>
Render the merged configured tools and aliases as deterministic TOML.
Both the [tools] and [aliases] headers are always present (even when empty), so the
output is a stable template a user can copy and edit. Each section’s presence is decided
from the data (whether the map is empty), not by scanning the serializer’s output.
Sourcepub fn load_from_dir(cwd: &Path, overrides: &ConfigOverrides) -> Result<Self>
pub fn load_from_dir(cwd: &Path, overrides: &ConfigOverrides) -> Result<Self>
Load config from the CLI args and a specified directory which may or may not contain config files.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Config
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnsafeUnpin for Config
impl UnwindSafe for Config
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);