Struct Rustdoc

pub struct Rustdoc {
    target: TargetSelection,
}

Fields

target: TargetSelection

Trait Implementations

impl Clone for Rustdoc

fn clone(&self) -> Rustdoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rustdoc

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

Formats the value using the given formatter.

impl Hash for Rustdoc

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 Rustdoc

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

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

Generates compiler documentation.

This will generate all documentation for compiler and dependencies. Compiler documentation is distributed separately, so we make sure we do not merge it with the other documentation from std, test and proc_macros. This is largely just a wrapper around cargo doc.

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

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

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.

impl Eq for Rustdoc

impl StructuralPartialEq for Rustdoc

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