Struct bootstrap::core::build_steps::test::BookTest

struct BookTest {
    compiler: Compiler,
    path: PathBuf,
    name: &'static str,
    is_ext_doc: bool,
}

Fields

compiler: Compiler

path: PathBuf

name: &'static str

is_ext_doc: bool

Implementations

impl BookTest

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

This runs the equivalent of mdbook test (via the rustbook wrapper) which in turn runs rustdoc --test on each file in the book.

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

This runs rustdoc --test on all .md files in the path.

Trait Implementations

impl Clone for BookTest

fn clone(&self) -> BookTest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BookTest

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

Formats the value using the given formatter.

impl Hash for BookTest

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 BookTest

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

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

Runs the documentation tests for a book in src/doc.

This uses the rustdoc that sits next to compiler.

type Output = ()

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

const ONLY_HOSTS: bool = true

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

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.

fn make_run(_run: RunConfig<'_>)

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

impl Eq for BookTest

impl StructuralPartialEq for BookTest

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