Trait Step

Source

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

    const DEFAULT: bool = false;
    const IS_HOST: bool = false;

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

    // Provided methods
    fn make_run(_run: RunConfig<'_>) { ... }
    fn metadata(&self) -> Option<StepMetadata> { ... }
}

Provided Associated Constants§

Source

const DEFAULT: bool = false

Whether this step is run by default as part of its respective phase, as defined by the describe macro in Builder::get_step_descriptions.

Note: Even if set to true, it can still be overridden with ShouldRun::default_condition by Step::should_run.

Source

const IS_HOST: bool = false

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.

A corollary of the above is that if this is set to true, then the step will be skipped if --target was specified, but --host was explicitly set to ‘’ (empty string).

Required Associated Types§

Source

type Output: Clone

Result type of Step::run.

Required Methods§

Source

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

Primary function to implement Step logic.

This function can be triggered in two ways:

Directly from Builder::execute_cli.
Indirectly by being called from other Steps using Builder::ensure.

When called with Builder::execute_cli (as done by Build::build), this function is executed twice:

First in “dry-run” mode to validate certain things (like cyclic Step invocations, directory creation, etc) super quickly.
Then it’s called again to run the actual, very expensive process.

When triggered indirectly from other Steps, it may still run twice (as dry-run and real mode) depending on the Step::run implementation of the caller.

Source

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

Determines if this Step should be run when given specific paths (e.g., x build $path).

Provided Methods§

Source

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.

Source

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

Returns metadata of the step, for tests

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait StepCopy item path

Provided Associated Constants§

const DEFAULT: bool = false

const IS_HOST: bool = false

Required Associated Types§

type Output: Clone

Required Methods§

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

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

Provided Methods§

fn make_run(_run: RunConfig<'_>)

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

Dyn Compatibility§

Implementors§

impl Step for Profile

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::Bootstrap

const IS_HOST: bool = true

const DEFAULT: bool = false

type Output = ()

impl Step for bootstrap::core::build_steps::check::CargoMiri

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::Clippy

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::Compiletest

const IS_HOST: bool = true

const DEFAULT: bool = false

type Output = ()

impl Step for bootstrap::core::build_steps::check::CoverageDump

const IS_HOST: bool = true

const DEFAULT: bool = false

type Output = ()

impl Step for bootstrap::core::build_steps::check::CraneliftCodegenBackend

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::FeaturesStatusDump

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::GccCodegenBackend

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::Linkchecker

const IS_HOST: bool = true

const DEFAULT: bool = false

type Output = ()

impl Step for bootstrap::core::build_steps::check::Miri

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::MiroptTestTools

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for PrepareRustcRmetaSysroot

type Output = RmetaSysroot

impl Step for PrepareStdRmetaSysroot

type Output = RmetaSysroot

impl Step for bootstrap::core::build_steps::check::RunMakeSupport

const IS_HOST: bool = true

const DEFAULT: bool = false

type Output = ()

impl Step for bootstrap::core::build_steps::check::RustAnalyzer

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for bootstrap::core::build_steps::check::Rustc

const IS_HOST: bool = true

const DEFAULT: bool = true

type Output = BuildStamp

impl Step for bootstrap::core::build_steps::check::Rustdoc

const IS_HOST: bool = true

const DEFAULT: bool = true

Trait Step