Struct BookTest 

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

Runs the documentation tests for a book in src/doc using the rustdoc of test_compiler.

Fields

test_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 Eq for BookTest

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Step for BookTest

type Output = ()

Result type of Step::run. Stored in the step cache for later lookup.

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

Executes this step.

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

Returns metadata of the step, for tests.

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