Struct Cgx 

pub struct Cgx { /* private fields */ }

Instance of the engine that powers the cgx tool.

This is packaged this way so that our main.rs is as minimal as possible. That’s useful for a few reasons, but in our particular case it’s because we want to be able to add cgx as a crate in others’ workspaces so that it can be invoked with cargo run or aliases and always available to everyone using the project whether or not they previously installed cgx on their systems.

Implementations

impl Cgx

pub fn new(config: Config, reporter: MessageReporter) -> Result<Self>

Create a new instance from a loaded configuration.

The config should be loaded using Config::load() with the CLI args.

pub fn prepare_bin_crate( &self, request: &CrateRequest, overrides: &BuildOverrides, ) -> Result<PathBuf>

Resolve a crate request into its build plan and produce the path to its binary.

This is the shared load-and-build impl that powers cgx <crate>, --no-exec, --prefetch, and each crate prefetched by --prefetch-all:

• loads the CrateSpec and BuildOptions from the engine’s config plus overrides,
• resolves the spec to a concrete version and downloads the source,
• returns a pre-built binary if one is available and enabled, otherwise builds from source.

Returns the fully-qualified path to the crate’s binary. Does NOT execute it.

pub fn list_targets( &self, request: &CrateRequest, overrides: &BuildOverrides, ) -> Result<(String, Option<Target>, Vec<Target>, Vec<Target>)>

Resolve a crate request and list its runnable targets without building or executing.

Loads the CrateSpec/BuildOptions from config plus overrides and downloads the source if needed, but does not build from source or look for a pre-built binary.

Returns (crate_name, default_target, bin_targets, example_targets).

pub fn list_configured_tools(&self) -> Result<String>

Enumerate the configured tools and aliases in the config, then return the rendered [tools]/[aliases] TOML.

pub fn prefetch( &self, label: &str, request: &CrateRequest, overrides: &BuildOverrides, ) -> Result<()>

Prefetch a single crate request: prepare its binary without executing it, reporting progress via messages::RunnerMessage::PrefetchStarted and messages::RunnerMessage::PrefetchCompleted.

This is the single-crate counterpart to Cgx::prefetch_all. label is the user-facing identifier shown in those messages: the raw CLI crate spec (e.g. ripgrep@1.0), the resolved crate name, or a <source> placeholder for source-only invocations.

pub fn prefetch_all(&self, overrides: &BuildOverrides) -> Result<()>

Prefetch every tool and alias configured in the [tools]/[aliases] config sections.

Tools and aliases are grouped by the crate they resolve to, so each distinct crate is prefetched exactly once no matter how many configured names point at it; the configured names are reported alongside it. Every configured tool is attempted even if some fail; if any failed, this returns error::Error::PrefetchAllFailed listing them.