Struct lit::Config

pub struct Config {
    pub supported_file_extensions: Vec<String>,
    pub test_paths: Vec<PathBuf>,
    pub constants: HashMap<String, String>,
    pub variable_lookup: VariableLookup,
    pub cleanup_temporary_files: bool,
}

The configuration of the test runner.

Fields

supported_file_extensions: Vec<String>

A list of file extensions which contain tests.

test_paths: Vec<PathBuf>

Paths to tests or folders containing tests.

constants: HashMap<String, String>

Constants that tests can refer to via @<name> syntax.

variable_lookup: VariableLookup

A function which used to dynamically lookup variables.

The default variable lookup can be found at Config::DEFAULT_VARIABLE_LOOKUP.

In your own custom variable lookups, most of the time you will want to include a fallback call to Config::DEFAULT_VARIABLE_LOOKUP.

cleanup_temporary_files: bool

Whether temporary files generated by the tests should be cleaned up, where possible.

This includes temporary files created by using @tempfile variables.

Implementations

impl Config

pub const DEFAULT_VARIABLE_LOOKUP: VariableLookup = _

The default variable lookup function.

The supported variables are:

• Any variable containing the string "tempfile"
  • Each distinct variable will be resolved to a distinct temporary file path.

pub fn add_extension<S>(&mut self, ext: S)where
    S: Into<String>,

Marks a file extension as supported by the runner.

We only attempt to run tests for files within the extension whitelist.

pub fn add_search_path<P>(&mut self, path: P)where
    P: Into<String>,

Adds a search path to the test runner.

We will recurse through the path to find tests.

pub fn is_extension_supported(&self, extension: &str) -> bool

Checks if a given extension will have tests run on it

pub fn lookup_variable<'a>(
    &self,
    name: &str,
    variables: &'a mut HashMap<String, String>
) -> &'a str

Looks up a variable.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.