Struct cargo::core::compiler::build_context::BuildContext
source · pub struct BuildContext<'a, 'cfg> {
pub ws: &'a Workspace<'cfg>,
pub config: &'cfg Config,
pub profiles: Profiles,
pub build_config: &'a BuildConfig,
pub extra_compiler_args: HashMap<Unit, Vec<String>>,
pub packages: PackageSet<'cfg>,
pub target_data: RustcTargetData<'cfg>,
pub roots: Vec<Unit>,
pub unit_graph: UnitGraph,
pub scrape_units: Vec<Unit>,
pub all_kinds: HashSet<CompileKind>,
}
Expand description
The build context, containing complete information needed for a build task before it gets started.
It is intended that this is mostly static information. Stuff that mutates
during the build can be found in the parent Context
. (I say mostly,
because this has internal caching, but nothing that should be observable
or require &mut.)
As a result, almost every field on BuildContext
is public, including
- a resolved
UnitGraph
of your dependencies, - a
Profiles
containing compiler flags presets, - a
RustcTargetData
containing host and target platform information, - and a
PackageSet
for further package downloads,
just to name a few. Learn more on each own documentation.
How to use
To prepare a build task, you may not want to use BuildContext::new
directly,
since it is often too lower-level.
Instead, ops::create_bcx
is usually what you are looking for.
After a BuildContext
is built, the next stage of building is handled in Context
.
Fields§
§ws: &'a Workspace<'cfg>
The workspace the build is for.
config: &'cfg Config
The cargo configuration.
profiles: Profiles
This contains a collection of compiler flags presets.
build_config: &'a BuildConfig
Configuration information for a rustc build.
extra_compiler_args: HashMap<Unit, Vec<String>>
Extra compiler args for either rustc
or rustdoc
.
packages: PackageSet<'cfg>
Package downloader.
This holds ownership of the Package
objects.
target_data: RustcTargetData<'cfg>
Information about rustc and the target platform.
roots: Vec<Unit>
The root units of unit_graph
(units requested on the command-line).
unit_graph: UnitGraph
The dependency graph of units to compile.
scrape_units: Vec<Unit>
Reverse-dependencies of documented units, used by the rustdoc --scrape-examples
flag.
all_kinds: HashSet<CompileKind>
The list of all kinds that are involved in this build
Implementations§
source§impl<'a, 'cfg> BuildContext<'a, 'cfg>
impl<'a, 'cfg> BuildContext<'a, 'cfg>
pub fn new( ws: &'a Workspace<'cfg>, packages: PackageSet<'cfg>, build_config: &'a BuildConfig, profiles: Profiles, extra_compiler_args: HashMap<Unit, Vec<String>>, target_data: RustcTargetData<'cfg>, roots: Vec<Unit>, unit_graph: UnitGraph, scrape_units: Vec<Unit> ) -> CargoResult<BuildContext<'a, 'cfg>>
sourcepub fn host_triple(&self) -> InternedString
pub fn host_triple(&self) -> InternedString
Gets the host architecture triple.
For example, x86_64-unknown-linux-gnu, would be
- machine: x86_64,
- hardware-platform: unknown,
- operating system: linux-gnu.
sourcepub fn rustflags_args(&self, unit: &Unit) -> &[String]
pub fn rustflags_args(&self, unit: &Unit) -> &[String]
Extra compiler flags to pass to rustc
for a given unit.
Although it depends on the caller, in the current Cargo implementation,
these flags take precedence over those from BuildContext::extra_args_for
.
As of now, these flags come from environment variables and configurations.
See TargetInfo.rustflags
for more on how Cargo collects them.
sourcepub fn rustdocflags_args(&self, unit: &Unit) -> &[String]
pub fn rustdocflags_args(&self, unit: &Unit) -> &[String]
Extra compiler flags to pass to rustdoc
for a given unit.
Although it depends on the caller, in the current Cargo implementation,
these flags take precedence over those from BuildContext::extra_args_for
.
As of now, these flags come from environment variables and configurations.
See TargetInfo.rustdocflags
for more on how Cargo collects them.
source§impl BuildContext<'_, '_>
impl BuildContext<'_, '_>
sourcepub fn scrape_units_have_dep_on<'a>(&'a self, unit: &'a Unit) -> Vec<&'a Unit>
pub fn scrape_units_have_dep_on<'a>(&'a self, unit: &'a Unit) -> Vec<&'a Unit>
Returns the set of Docscrape
units that have a direct dependency on unit
.
RunCustomBuild
units are excluded because we allow failures
from type checks but not build script executions.
A plain old cargo doc
would just die if a build script execution fails,
there is no reason for -Zrustdoc-scrape-examples
to keep going.
sourcepub fn unit_can_fail_for_docscraping(&self, unit: &Unit) -> bool
pub fn unit_can_fail_for_docscraping(&self, unit: &Unit) -> bool
Returns true if this unit is needed for doing doc-scraping and is also allowed to fail without killing the build.
Auto Trait Implementations§
impl<'a, 'cfg> !RefUnwindSafe for BuildContext<'a, 'cfg>
impl<'a, 'cfg> !Send for BuildContext<'a, 'cfg>
impl<'a, 'cfg> !Sync for BuildContext<'a, 'cfg>
impl<'a, 'cfg> Unpin for BuildContext<'a, 'cfg>
impl<'a, 'cfg> !UnwindSafe for BuildContext<'a, 'cfg>
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> 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> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 1608 bytes