Module doctest

Modules

extracted 🔒

Rustdoc’s doctest extraction.

make 🔒

Logic for transforming the raw code given by the user into something actually runnable, e.g. by adding a main function if it doesn’t already exist.

markdown 🔒

Doctest functionality used only for doctests in .md Markdown files.

runner 🔒

rust 🔒

Doctest functionality used only for doctests in .rs source files.

Structs

CreateRunnableDocTests 🔒

GlobalTestOptions 🔒

Options that apply to all doctests in a crate or Markdown file (for rustdoc foo.md).

IndividualTestOptions 🔒

RunnableDocTest 🔒

Information needed for running a bundle of doctests.

ScrapedDocTest 🔒

A doctest scraped from the code, ready to be turned into a runnable test.

UnusedExterns 🔒

Enums

DirState 🔒

TestFailure 🔒

Documentation test failure modes.

Traits

DocTestVisitor 🔒

Functions

add_exe_suffix 🔒

doctest_run_fn 🔒

generate_args_file 🔒

generate_test_desc_and_fn 🔒

get_doctest_dir 🔒

make_maybe_absolute_path 🔒

Converts a path intended to use as a command to absolute if it is relative, and not a single component.

run 🔒

run_test 🔒

Execute a RunnableDoctest.

run_tests 🔒

scrape_test_config 🔒

split_args 🔒

Function used to split command line arguments just like a shell would.

wrapped_rustc_command 🔒