Struct DocTest 

pub struct DocTest {
    pub name: String,
    pub place: String,
    pub text: String,
    pub file: String,
    pub start: u32,
    pub lines: Vec<Origin>,
    pub unknown: Vec<String>,
}

A doc test: one Nova code block of the docs a library’s site shows, as a test module (spec §5).

Fields

name: String

shapes::circle (src/lib.nova:41) (spec §5.3).

place: String

src/lib.nova:41: where the block starts, which an unknown word’s warning names (spec §4.2).

text: String

The module’s text (spec §5), ending in a line break.

file: String

The block’s file, by its name in the program’s FileDb: the path the loader read it from, as Path::display writes it, or <std/time> for std’s.

start: u32

Where the block starts in file: its opening fence, or an indented block’s first line, which added lines map to (spec §7).

lines: Vec<Origin>

Where each line of text comes from.

unknown: Vec<String>

The words after nova that mean nothing (spec §4.2).

Implementations

impl DocTest

pub fn map(&self, offset: u32) -> u32

Where byte offset of text is in file (spec §7). A hidden line’s column after its cut moves past its # , and an added line is at start.

Trait Implementations

impl Clone for DocTest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocTest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for DocTest

impl PartialEq for DocTest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocTest