Trait Step

source

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<'_>) { ... }
}

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 ONLY_HOSTS: bool = false

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

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: 1. Directly from Builder::execute_cli. 2. Indirectly by being called from other Steps using Builder::ensure.

When called with Builder::execute_cli (as done by Build::build), this function 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.

Object Safety§

This trait is not object safe.

Trait StepCopy item path

Provided Associated Constants§

const DEFAULT: bool = false

const ONLY_HOSTS: 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<'_>)

Object Safety§

Implementors§

impl Step for Profile

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = false

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

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

const DEFAULT: bool = true

type Output = ()

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

const ONLY_HOSTS: bool = true

const DEFAULT: bool = true

type Output = ()

impl Step for CleanAll

const DEFAULT: bool = true

type Output = ()

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

type Output = ()

impl Step for bootstrap::core::build_steps::clean::Std

type Output = ()

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

const DEFAULT: bool = false

type Output = ()

impl Step for bootstrap::core::build_steps::clippy::BuildHelper

const DEFAULT: bool = false

type Output = ()

Trait Step