Struct rustdoc::doctest::make::DocTestBuilder

pub(crate) struct DocTestBuilder {
    pub(crate) supports_color: bool,
    pub(crate) already_has_extern_crate: bool,
    pub(crate) has_main_fn: bool,
    pub(crate) crate_attrs: String,
    pub(crate) maybe_crate_attrs: String,
    pub(crate) crates: String,
    pub(crate) everything_else: String,
    pub(crate) test_id: Option<String>,
    pub(crate) failed_ast: bool,
    pub(crate) can_be_merged: bool,
}

This struct contains information about the doctest itself which is then used to generate doctest source code appropriately.

Fields

supports_color: bool

already_has_extern_crate: bool

has_main_fn: bool

crate_attrs: String

maybe_crate_attrs: String

If this is a merged doctest, it will be put into everything_else, otherwise it will put into crate_attrs.

crates: String

everything_else: String

test_id: Option<String>

failed_ast: bool

can_be_merged: bool

Implementations

impl DocTestBuilder

pub(crate) fn new( source: &str, crate_name: Option<&str>, edition: Edition, can_merge_doctests: bool, test_id: Option<String>, lang_str: Option<&LangString>, ) -> Self

pub(crate) fn generate_unique_doctest( &self, test_code: &str, dont_insert_main: bool, opts: &GlobalTestOptions, crate_name: Option<&str>, ) -> (String, usize)

Transforms a test into code that can be compiled into a Rust binary, and returns the number of lines before the test code begins.

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