Skip to main content

Module doctest

rustdoc

Module doctest 

Source

Re-exports§

use std::fs::File; 🔒
use std::hash::Hash; 🔒
use std::hash::Hash; 🔒
use std::hash::Hasher; 🔒
use std::io; 🔒
use std::io::Write; 🔒
use std::path::Path; 🔒
use std::path::PathBuf; 🔒
use std::process; 🔒
use std::process::Command; 🔒
use std::process::Stdio; 🔒
use std::str::FromStr; 🔒
use std::sync::atomic::AtomicUsize; 🔒
use std::sync::atomic::Ordering; 🔒
use std::sync::Arc; 🔒
use std::sync::Mutex; 🔒
use std::time::Duration; 🔒
use std::time::Instant; 🔒
use std::panic; 🔒
use std::panic; 🔒
use std::str; 🔒
pub(crate) use make::BuildDocTestBuilder; 🔒
pub(crate) use make::DocTestBuilder; 🔒
pub(crate) use markdown::test as test_markdown; 🔒
use proc_macro2::TokenStream; 🔒
use proc_macro2::TokenTree; 🔒
use rustc_attr_ir::Attribute; 🔒
use rustc_attr_ir::AttributeKind; 🔒
use rustc_data_structures::fx::FxHashMap; 🔒
use rustc_data_structures::fx::FxHashSet; 🔒
use rustc_data_structures::fx::FxHasher; 🔒
use rustc_data_structures::fx::FxIndexMap; 🔒
use rustc_data_structures::fx::FxIndexSet; 🔒
use rustc_errors::emitter::HumanReadableErrorType; 🔒
use rustc_errors::ColorConfig; 🔒
use rustc_errors::DiagCtxtHandle; 🔒
use rustc_hir::CRATE_HIR_ID; 🔒
use rustc_hir::def_id::LOCAL_CRATE; 🔒
use rustc_interface::interface; 🔒
use rustc_lint as lint; 🔒
use rustc_middle::ty::TyCtxt; 🔒
use rustc_session::config; 🔒
use rustc_session::config::ErrorOutputType; 🔒
use rustc_session::config::Input; 🔒
use rustc_span::edition::Edition; 🔒
use rustc_span::FileName; 🔒
use rustc_span::RemapPathScopeComponents; 🔒
use rustc_span::Span; 🔒
use rustc_structures::CrateType; 🔒
use rustc_target::spec::Target; 🔒
use rustc_target::spec::TargetTuple; 🔒
use tempfile::Builder as TempFileBuilder; 🔒
use tempfile::TempDir; 🔒
use tracing::debug; 🔒
use tracing::info; 🔒
use self::rust::HirCollector; 🔒
use crate::config::MergeDoctests; 🔒
use crate::config::Options as RustdocOptions; 🔒
use crate::config::OutputFormat; 🔒
use crate::html::markdown::CodeBlockPosition; 🔒
use crate::html::markdown::CodeLineMapping; 🔒
use crate::html::markdown::ErrorCodes; 🔒
use crate::html::markdown::Ignore; 🔒
use crate::html::markdown::LangString; 🔒
use crate::lint::init_lints; 🔒

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 🔒
MergeableTestKey 🔒
MergedDoctestTimes 🔒
Type used to display times (compilation and total) information for merged doctests.
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 🔒
wrapped_rustc_command 🔒