Trait bootstrap::builder::Step

pub trait Step: 'static + Clone + Debug + PartialEq + Eq + Hash {
    type Output: Clone;

    const DEFAULT: bool = false;
    const ONLY_HOSTS: bool = false;

    // Required methods
    fn run(self, builder: &Builder<'_>) -> Self::Output;
    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;

    // Provided method
    fn make_run(_run: RunConfig<'_>) { ... }
}

Required Associated Types

type Output: Clone

PathBuf when directories are created or to return a Compiler once it’s been assembled.

Provided Associated Constants

const DEFAULT: bool = false

Whether this step is run by default as part of its respective phase. true here can still be overwritten by should_run calling default_condition.

const ONLY_HOSTS: bool = false

If true, then this rule should be skipped if –target was specified, but –host was not

Required Methods

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

Primary function to execute this rule. Can call builder.ensure() with other steps to run those.

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

When bootstrap is passed a set of paths, this controls whether this rule will execute. However, it does not get called in a “default” context when we are not passed any paths; in that case, make_run is called directly.

Provided Methods

fn make_run(_run: RunConfig<'_>)

Builds up a “root” rule, either as a default rule or from a path passed to us.

When path is None, we are executing in a context where no paths were passed. When ./x.py build is run, for example, this rule could get called if it is in the correct list below with a path of None.

Implementors

impl Step for Profile

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::check::Bootstrap

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = false

impl Step for bootstrap::check::CargoMiri

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Clippy

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::CodegenBackend

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Miri

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for MiroptTestTools

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Rls

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::RustAnalyzer

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Rustc

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Rustdoc

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Rustfmt

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::check::Std

type Output = ()

const DEFAULT: bool = true

impl Step for CleanAll

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::clean::Rustc

type Output = ()

impl Step for bootstrap::clean::Std

type Output = ()

impl Step for Assemble

type Output = Compiler

const ONLY_HOSTS: bool = true

impl Step for bootstrap::compile::CodegenBackend

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::compile::Rustc

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = false

impl Step for RustcLink

type Output = ()

impl Step for StartupObjects

type Output = Vec<(PathBuf, DependencyType), Global>

impl Step for bootstrap::compile::Std

type Output = ()

const DEFAULT: bool = true

impl Step for StdLink

type Output = ()

impl Step for Sysroot

type Output = Interned<PathBuf>

impl Step for Analysis

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

impl Step for bootstrap::dist::Bootstrap

type Output = Option<GeneratedTarball>

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::BuildManifest

type Output = GeneratedTarball

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::Cargo

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::Clippy

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for DebuggerScripts

type Output = ()

impl Step for bootstrap::dist::Docs

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

impl Step for Extended

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for JsonDocs

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

impl Step for bootstrap::dist::LlvmTools

type Output = Option<GeneratedTarball>

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for Mingw

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

impl Step for bootstrap::dist::Miri

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for PlainSourceTarball

type Output = GeneratedTarball

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for ReproducibleArtifacts

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::Rls

type Output = Option<GeneratedTarball>

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::dist::RustAnalyzer

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::RustDemangler

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustDev

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::Rustc

type Output = GeneratedTarball

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustcDev

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustcDocs

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

impl Step for bootstrap::dist::Rustfmt

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::Src

type Output = GeneratedTarball

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::dist::Std

type Output = Option<GeneratedTarball>

const DEFAULT: bool = true

impl Step for bootstrap::doc::Bootstrap

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::Cargo

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for CargoBook

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::Clippy

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for ClippyBook

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::EditionGuide

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::EmbeddedBook

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::ErrorIndex

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::Miri

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::Nomicon

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::Reference

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::RustByExample

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::Rustc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::RustcBook

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::Rustdoc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::RustdocBook

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::Rustfmt

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for SharedAssets

type Output = SharedAssetsPaths

const DEFAULT: bool = false

impl Step for Standalone

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::Std

type Output = ()

const DEFAULT: bool = true

impl Step for StyleGuide

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::TheBook

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::Tidy

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::doc::UnstableBook

type Output = ()

const DEFAULT: bool = true

impl Step for bootstrap::doc::UnstableBookGen

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Cargo

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Clippy

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Docs

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for bootstrap::install::LlvmTools

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Miri

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::RustAnalyzer

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::RustDemangler

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Rustc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Rustfmt

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Src

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::install::Std

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for CrtBeginEnd

type Output = PathBuf

impl Step for Libunwind

type Output = PathBuf

impl Step for Lld

type Output = PathBuf

const ONLY_HOSTS: bool = true

impl Step for Llvm

type Output = LlvmResult

const ONLY_HOSTS: bool = true

impl Step for Sanitizers

type Output = Vec<SanitizerRuntime, Global>

impl Step for bootstrap::run::BuildManifest

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for bootstrap::run::BumpStage0

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for bootstrap::run::CollectLicenseMetadata

type Output = PathBuf

const ONLY_HOSTS: bool = true

impl Step for bootstrap::run::ExpandYamlAnchors

type Output = ()

impl Step for GenerateCompletions

type Output = ()

impl Step for bootstrap::run::GenerateCopyright

type Output = PathBuf

const ONLY_HOSTS: bool = true

impl Step for bootstrap::run::GenerateWindowsSys

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for bootstrap::run::Miri

type Output = ()

const ONLY_HOSTS: bool = false

impl Step for bootstrap::run::ReplaceVersionPlaceholder

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for Hook

type Output = ()

const DEFAULT: bool = true

impl Step for Link

type Output = ()

const DEFAULT: bool = true

impl Step for Vscode

type Output = ()

const DEFAULT: bool = true

impl Step for MirOptPanicAbortSyntheticTarget

type Output = TargetSelection

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for Assembly

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for BookTest

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Bootstrap

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Cargo

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for Cargotest

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Clippy

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = false

impl Step for Codegen

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for CodegenCranelift

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for CodegenUnits

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for bootstrap::test::Compiletest

type Output = ()

impl Step for CompiletestTest

type Output = ()

impl Step for CoverageMap

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for Crate

type Output = ()

const DEFAULT: bool = true

impl Step for CrateBootstrap

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for CrateLibrustc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for CrateRustdoc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for CrateRustdocJsonTypes

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for Debuginfo

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for Distcheck

type Output = ()

impl Step for bootstrap::test::EditionGuide

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::EmbeddedBook

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::ErrorIndex

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::ExpandYamlAnchors

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for HtmlCheck

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for Incremental

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for Linkcheck

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::test::LintDocs

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for MirOpt

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for bootstrap::test::Miri

type Output = ()

const ONLY_HOSTS: bool = false

impl Step for bootstrap::test::Nomicon

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for Pretty

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Reference

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for RemoteCopyLibs

type Output = ()

impl Step for RunCoverage

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RunCoverageRustdoc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RunMake

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for RunMakeFullDeps

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RunPassValgrind

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for bootstrap::test::RustAnalyzer

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::test::RustByExample

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::RustDemangler

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::RustInstaller

type Output = ()

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

impl Step for bootstrap::test::RustcBook

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustcGuide

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Rustdoc

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::RustdocBook

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustdocGUI

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustdocJSNotStd

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustdocJSStd

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustdocJson

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::RustdocTheme

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustdocUi

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Rustfmt

type Output = ()

const ONLY_HOSTS: bool = true

impl Step for TestHelpers

type Output = ()

impl Step for bootstrap::test::TheBook

type Output = ()

const DEFAULT: bool = false

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::Tidy

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for TierCheck

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for Ui

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = false

impl Step for UiFullDeps

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::test::UnstableBook

type Output = ()

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::BuildManifest

type Output = PathBuf

impl Step for bootstrap::tool::BumpStage0

type Output = PathBuf

impl Step for bootstrap::tool::Cargo

type Output = PathBuf

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for CargoClippy

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::CargoMiri

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for CargoTest

type Output = PathBuf

impl Step for Cargofmt

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::Clippy

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::CollectLicenseMetadata

type Output = PathBuf

impl Step for bootstrap::tool::Compiletest

type Output = PathBuf

impl Step for CoverageDump

type Output = PathBuf

impl Step for bootstrap::tool::ErrorIndex

type Output = PathBuf

impl Step for bootstrap::tool::ExpandYamlAnchors

type Output = PathBuf

impl Step for bootstrap::tool::GenerateCopyright

type Output = PathBuf

impl Step for bootstrap::tool::GenerateWindowsSys

type Output = PathBuf

impl Step for HtmlChecker

type Output = PathBuf

impl Step for JsonDocCk

type Output = PathBuf

impl Step for JsonDocLint

type Output = PathBuf

impl Step for Linkchecker

type Output = PathBuf

impl Step for bootstrap::tool::LintDocs

type Output = PathBuf

impl Step for LldWrapper

type Output = PathBuf

impl Step for bootstrap::tool::Miri

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for OptimizedDist

type Output = PathBuf

impl Step for RemoteTestClient

type Output = PathBuf

impl Step for RemoteTestServer

type Output = PathBuf

impl Step for bootstrap::tool::ReplaceVersionPlaceholder

type Output = PathBuf

impl Step for bootstrap::tool::Rls

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::RustAnalyzer

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustAnalyzerProcMacroSrv

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::RustDemangler

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for bootstrap::tool::RustInstaller

type Output = PathBuf

impl Step for Rustbook

type Output = PathBuf

impl Step for bootstrap::tool::Rustdoc

type Output = PathBuf

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for RustdocGUITest

type Output = PathBuf

impl Step for bootstrap::tool::RustdocTheme

type Output = PathBuf

impl Step for bootstrap::tool::Rustfmt

type Output = Option<PathBuf>

const DEFAULT: bool = true

const ONLY_HOSTS: bool = true

impl Step for SuggestTests

type Output = PathBuf

impl Step for bootstrap::tool::Tidy

type Output = PathBuf

impl Step for ToolBuild

type Output = Option<PathBuf>

impl Step for bootstrap::tool::UnstableBookGen

type Output = PathBuf

impl Step for ToolStateCheck

type Output = ()

impl<P: Step> Step for RustbookSrc<P>

type Output = ()