Struct RustcBook

pub struct RustcBook {
    build_compiler: Compiler,
    target: TargetSelection,
    validate: bool,
}

Builds the Rust compiler book.

Fields

build_compiler: Compiler

target: TargetSelection

validate: bool

Test that the examples of lints in the book produce the correct lints in the expected format.

Implementations

impl RustcBook

pub fn validate(build_compiler: Compiler, target: TargetSelection) -> Self

Trait Implementations

impl Clone for RustcBook

fn clone(&self) -> RustcBook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustcBook

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

Formats the value using the given formatter.

impl Hash for RustcBook

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 RustcBook

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Step for RustcBook

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

Builds the rustc book.

The lints are auto-generated by a tool, and then merged into the book in the “md-doc” directory in the build output directory. Then “rustbook” is used to convert it to HTML.

const DEFAULT: bool = true

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

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 = ()

Result type of Step::run.

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

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

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 metadata(&self) -> Option<StepMetadata>

Returns metadata of the step, for tests

impl Eq for RustcBook

impl StructuralPartialEq for RustcBook

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