Struct bootstrap::core::build_steps::doc::RustbookSrc

struct RustbookSrc<P: Step> {
    target: TargetSelection,
    name: String,
    src: PathBuf,
    parent: Option<P>,
    languages: Vec<&'static str>,
    rustdoc_compiler: Option<Compiler>,
}

Fields

target: TargetSelection

name: String

src: PathBuf

parent: Option<P>

languages: Vec<&'static str>

rustdoc_compiler: Option<Compiler>

Trait Implementations

impl<P: Clone + Step> Clone for RustbookSrc<P>

fn clone(&self) -> RustbookSrc<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug + Step> Debug for RustbookSrc<P>

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

Formats the value using the given formatter.

impl<P: Hash + Step> Hash for RustbookSrc<P>

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<P: PartialEq + Step> PartialEq for RustbookSrc<P>

fn eq(&self, other: &RustbookSrc<P>) -> 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<P: Step> Step for RustbookSrc<P>

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

Invoke rustbook for target for the doc book name from the src path.

This will not actually generate any documentation if the documentation has already been generated.

type Output = ()

PathBuf when directories are created or to return a Compiler once it’s been assembled.

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

When bootstrap is passed a set of paths, this controls whether this rule will execute. However, it does not get called in a “default” context when we are not passed any paths; in that case, make_run is called directly.

const DEFAULT: bool = false

Whether this step is run by default as part of its respective phase. true here can still be overwritten by should_run calling default_condition.

const ONLY_HOSTS: bool = false

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

fn make_run(_run: RunConfig<'_>)

Builds up a “root” rule, either as a default rule or from a path passed to us.

impl<P: Eq + Step> Eq for RustbookSrc<P>

impl<P: Step> StructuralPartialEq for RustbookSrc<P>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.