pub struct RustcInvocation { /* private fields */ }Expand description
Parsed, cache-safe model of one rustc command line.
Fields are intentionally private so new modeled flags can be added without exposing the adapter’s internal representation.
Implementations§
Source§impl RustcInvocation
impl RustcInvocation
Sourcepub fn dep_info_command(
&self,
output: &Path,
) -> Result<DepInfoCommand, BypassReason>
pub fn dep_info_command( &self, output: &Path, ) -> Result<DepInfoCommand, BypassReason>
Replace the original output flags with a single explicit dep-info file.
Sourcepub fn discover_inputs(
&self,
dep_info: &RustcDepInfo,
working_dir: &Path,
) -> Result<DiscoveredInputs, BypassReason>
pub fn discover_inputs( &self, dep_info: &RustcDepInfo, working_dir: &Path, ) -> Result<DiscoveredInputs, BypassReason>
Hash dep-info sources plus every direct compiler input already modeled
by the invocation (--extern artifacts and custom target specs).
Sourcepub fn discover_inputs_with_mappings(
&self,
dep_info: &RustcDepInfo,
working_dir: &Path,
path_mappings: &[PathMapping],
digests: &dyn FileDigestCache,
) -> Result<DiscoveredInputs, BypassReason>
pub fn discover_inputs_with_mappings( &self, dep_info: &RustcDepInfo, working_dir: &Path, path_mappings: &[PathMapping], digests: &dyn FileDigestCache, ) -> Result<DiscoveredInputs, BypassReason>
Hash dep-info sources plus modeled compiler inputs, allowing native search directories beneath the working directory or a mapped root.
digests may answer for files the session already read in full;
pass mbx_cache_core::NoFileDigestCache to hash everything.
Source§impl RustcInvocation
impl RustcInvocation
Sourcepub fn parse(arguments: &[OsString]) -> Result<Self, BypassReason>
pub fn parse(arguments: &[OsString]) -> Result<Self, BypassReason>
Parse rustc’s arguments, excluding the compiler executable supplied as
the first argument to RUSTC_WRAPPER.
Any flag whose cache semantics are not modeled returns a bypass reason
instead of guessing. A successful parse admits the rlib/rmeta tier,
every compilation that links nothing at all – what cargo check and
clippy run, whatever the crate type – and binaries linked by
compiler-bundled WebAssembly toolchains.
Sourcepub fn parse_with(
arguments: &[OsString],
options: ParseOptions,
) -> Result<Self, BypassReason>
pub fn parse_with( arguments: &[OsString], options: ParseOptions, ) -> Result<Self, BypassReason>
Parse as RustcInvocation::parse does, admitting what options
says the caller can model.
Sourcepub fn links_natively(&self) -> bool
pub fn links_natively(&self) -> bool
Whether this invocation links a native artifact, whose key must therefore describe the linker that produced it.
Sourcepub fn linker_override(&self) -> Option<&Path>
pub fn linker_override(&self) -> Option<&Path>
Linker selected with -C linker, if the invocation overrides rustc’s
platform default.
Sourcepub fn target(&self) -> Option<&str>
pub fn target(&self) -> Option<&str>
Return the explicitly selected compilation target, if any.
Sourcepub fn crate_name(&self) -> &str
pub fn crate_name(&self) -> &str
Return the crate name rustc will assign to this compilation.
Sourcepub fn source_fingerprint(&self, discovered: &DiscoveredInputs) -> CacheDigest
pub fn source_fingerprint(&self, discovered: &DiscoveredInputs) -> CacheDigest
Digest of the inputs this compilation owns: its sources and whatever they read, but not the artifacts it merely links against.
This is what separates a crate someone is editing from one sitting above it in the graph. Rebuilding a dependency changes the action key of every crate that links it, because their keys hash its artifact; it does not change this. A caller watching for churn has to watch this instead, or a single edited crate would drag its whole dependent cone along.
Host paths enter the digest as they are. This describes one checkout to itself rather than to the cache, so there is nothing here to make portable.
Sourcepub fn outputs(&self, working_dir: &Path) -> Result<RustcOutputs, BypassReason>
pub fn outputs(&self, working_dir: &Path) -> Result<RustcOutputs, BypassReason>
Resolve the files produced by this invocation.
The initial cache tier requires one output directory so its artifact can be represented by one protocol directory and restored atomically later.
Sourcepub fn action(
&self,
context: ActionContext,
) -> Result<RustcAction, BypassReason>
pub fn action( &self, context: ActionContext, ) -> Result<RustcAction, BypassReason>
Build canonical action bytes after precise input discovery has run.
context.inputs must contain the source, every explicit extern, and
every additional source or environment-generated input discovered from
dep-info.
Sourcepub fn action_linked_by(
&self,
context: ActionContext,
linker: Option<LinkerIdentity>,
) -> Result<RustcAction, BypassReason>
pub fn action_linked_by( &self, context: ActionContext, linker: Option<LinkerIdentity>, ) -> Result<RustcAction, BypassReason>
Build canonical action bytes for an invocation that links a native program.
A linker is required whenever RustcInvocation::links_natively
holds: the linker, its startup objects, and the platform SDK are inputs
rustc dep-info does not enumerate, so a key without them would claim
more than it can support. Passing one for anything else is ignored,
since nothing else depends on a linker.
Sourcepub fn invocation_digest(
&self,
context: &ActionContext,
) -> Result<CacheDigest, BypassReason>
pub fn invocation_digest( &self, context: &ActionContext, ) -> Result<CacheDigest, BypassReason>
Fingerprint the modeled invocation before dependency contents are known.
Sourcepub fn prediction(
&self,
context: &ActionContext,
discovered: &DiscoveredInputs,
) -> Result<RustcInputPrediction, BypassReason>
pub fn prediction( &self, context: &ActionContext, discovered: &DiscoveredInputs, ) -> Result<RustcInputPrediction, BypassReason>
Capture normalized dependency paths for a future invocation that has no dep-info file yet.
Trait Implementations§
Source§impl Clone for RustcInvocation
impl Clone for RustcInvocation
Source§fn clone(&self) -> RustcInvocation
fn clone(&self) -> RustcInvocation
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more