Skip to main content

RustcInvocation

Struct RustcInvocation 

Source
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

Source

pub fn dep_info_command( &self, output: &Path, ) -> Result<DepInfoCommand, BypassReason>

Replace the original output flags with a single explicit dep-info file.

Source

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).

Source

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

Source

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.

Source

pub fn parse_with( arguments: &[OsString], options: ParseOptions, ) -> Result<Self, BypassReason>

Parse as RustcInvocation::parse does, admitting what options says the caller can model.

Whether this invocation links a native artifact, whose key must therefore describe the linker that produced it.

Source

pub fn linker_override(&self) -> Option<&Path>

Linker selected with -C linker, if the invocation overrides rustc’s platform default.

Source

pub fn source(&self) -> &Path

Return the source input passed to rustc.

Source

pub fn target(&self) -> Option<&str>

Return the explicitly selected compilation target, if any.

Source

pub fn crate_name(&self) -> &str

Return the crate name rustc will assign to this compilation.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn invocation_digest( &self, context: &ActionContext, ) -> Result<CacheDigest, BypassReason>

Fingerprint the modeled invocation before dependency contents are known.

Source

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

Source§

fn clone(&self) -> RustcInvocation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RustcInvocation

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for RustcInvocation

Source§

impl PartialEq for RustcInvocation

Source§

fn eq(&self, other: &RustcInvocation) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RustcInvocation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more