Struct BookTest

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

Fields

compiler: Compiler

path: PathBuf

name: &'static str

is_ext_doc: bool

dependencies: Vec<&'static str>

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 duplicate 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.

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).

const DEFAULT: bool = false

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

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