Struct RustcDocs

pub struct RustcDocs {
    target: TargetSelection,
}

Builds the rustc-docs installer component. Apart from the documentation of the rustc_* crates, it also includes the documentation of various in-tree helper tools (bootstrap, build_helper, tidy), and also rustc_private tools like rustdoc, clippy, miri or rustfmt.

It is currently hosted at https://doc.rust-lang.org/nightly/nightly-rustc.

Fields

target: TargetSelection

Trait Implementations

impl Clone for RustcDocs

fn clone(&self) -> RustcDocs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustcDocs

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

Formats the value using the given formatter.

impl Hash for RustcDocs

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 RustcDocs

fn eq(&self, other: &RustcDocs) -> 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 RustcDocs

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 = GeneratedTarball

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 run(self, builder: &Builder<'_>) -> Self::Output

Primary function to implement Step logic.

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

Returns metadata of the step, for tests

impl Eq for RustcDocs

impl StructuralPartialEq for RustcDocs

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