Struct CompilerWithTools 

pub struct CompilerWithTools {
    build_compiler: Compiler,
    target: TargetSelection,
    stage: u32,
}

Generate the combined compiler + tools docs for a given toolchain. This contains both the compiler docs, docs of rustc_private tools (miri, clippy, etc.), cargo and also some bootstrap related tools (bootstrap itself, compiletest, tidy, etc.).

It gets hosted at https://doc.rust-lang.org/nightly/nightly-rustc/index.html.

Compiler documentation is distributed separately, so we make sure we do not merge it with the other documentation from std, test and proc_macros. This is largely just a wrapper around cargo doc.

Returns a path to a directory with the generated documentation.

Fields

build_compiler: Compiler

target: TargetSelection

stage: u32

Implementations

impl CompilerWithTools

pub(crate) fn for_stage( builder: &Builder<'_>, stage: u32, target: TargetSelection, ) -> Self

Document stage compiler for the given target.

Trait Implementations

impl Clone for CompilerWithTools

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandLineStep for CompilerWithTools

const IS_HOST: bool = true

If this value is true, then the values of run.target passed to the make_run function of this Step will be determined based on the --host flag. If this value is false, then they will be determined based on the --target flag.

type Output = PathBuf

Result type of Step::run.

fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>

Called to allow steps to register the command-line paths that should cause them to run.

fn is_default_step(builder: &Builder<'_>) -> bool

Should this step run when the user invokes bootstrap with a subcommand but no paths/aliases?

fn make_run(run: RunConfig<'_>)

Called directly by the bootstrap Step handler when not triggered indirectly by other Steps using Builder::ensure. For example, ./x.py test bootstrap runs this for test::Bootstrap. Similarly, ./x.py test runs it for every step that is listed by the describe macro in Builder::get_step_descriptions.

fn run(self, builder: &Builder<'_>) -> Self::Output

Used as the implementation of Step::run.

fn metadata(&self) -> Option<StepMetadata>

Used as the implementation of Step::metadata.

impl Debug for CompilerWithTools

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

Formats the value using the given formatter.

impl Eq for CompilerWithTools

impl Hash for CompilerWithTools

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CompilerWithTools

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompilerWithTools

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: 80 bytes