Struct ui_test::Config

pub struct Config {

    pub host: Option<String>,
    pub target: Option<String>,
    pub stderr_filters: Filter,
    pub stdout_filters: Filter,
    pub root_dir: PathBuf,
    pub mode: Mode,
    pub program: CommandBuilder,
    pub cfgs: CommandBuilder,
    pub output_conflict_handling: OutputConflictHandling,
    pub dependencies_crate_manifest_path: Option<PathBuf>,
    pub dependency_builder: CommandBuilder,
    pub out_dir: PathBuf,
    pub edition: Option<String>,
    pub skip_files: Vec<String>,
    pub filter_files: Vec<String>,
    pub threads: Option<NonZeroUsize>,
}

Central datastructure containing all information to run the tests.

Fields

host: Option<String>

Host triple; usually will be auto-detected.

target: Option<String>

None to run on the host, otherwise a target triple

stderr_filters: Filter

Filters applied to stderr output before processing it. By default contains a filter for replacing backslashes in paths with regular slashes. On windows, contains a filter to remove \r.

stdout_filters: Filter

Filters applied to stdout output before processing it. On windows, contains a filter to remove \r.

root_dir: PathBuf

The folder in which to start searching for .rs files

mode: Mode

The mode in which to run the tests.

program: CommandBuilder

The binary to actually execute.

cfgs: CommandBuilder

The command to run to obtain the cfgs that the output is supposed to

output_conflict_handling: OutputConflictHandling

What to do in case the stdout/stderr output differs from the expected one.

dependencies_crate_manifest_path: Option<PathBuf>

Path to a Cargo.toml that describes which dependencies the tests can access.

dependency_builder: CommandBuilder

The command to run can be changed from cargo to any custom command to build the dependencies in dependencies_crate_manifest_path.

out_dir: PathBuf

Where to dump files like the binaries compiled from tests. Defaults to target/ui in the current directory.

edition: Option<String>

The default edition to use on all tests.

skip_files: Vec<String>

Skip test files whose names contain any of these entries.

filter_files: Vec<String>

Only test files whose names contain any of these entries.

threads: Option<NonZeroUsize>

Override the number of threads to use.

Implementations

impl Config

pub fn rustc(root_dir: impl Into<PathBuf>) -> Self

Create a configuration for testing the output of running rustc on the test files.

pub fn cargo(root_dir: impl Into<PathBuf>) -> Self

Create a configuration for testing the output of running cargo on the test Cargo.toml files.

pub fn with_args(&mut self, args: &Args, default_bless: bool)

Populate the config with the values from parsed command line arguments. If neither --bless or --check are provided default_bless is used.

The default output conflict handling command suggests adding --bless to the end of the current command.

pub fn path_filter( &mut self, path: &Path, replacement: &'static (impl AsRef<[u8]> + ?Sized) )

Replace all occurrences of a path in stderr/stdout with a byte string.

pub fn path_stderr_filter( &mut self, path: &Path, replacement: &'static (impl AsRef<[u8]> + ?Sized) )

Replace all occurrences of a path in stderr with a byte string.

pub fn path_stdout_filter( &mut self, path: &Path, replacement: &'static (impl AsRef<[u8]> + ?Sized) )

Replace all occurrences of a path in stdout with a byte string.

pub fn filter( &mut self, pattern: &str, replacement: &'static (impl AsRef<[u8]> + ?Sized) )

Replace all occurrences of a regex pattern in stderr/stdout with a byte string.

pub fn stderr_filter( &mut self, pattern: &str, replacement: &'static (impl AsRef<[u8]> + ?Sized) )

Replace all occurrences of a regex pattern in stderr with a byte string.

pub fn stdout_filter( &mut self, pattern: &str, replacement: &'static (impl AsRef<[u8]> + ?Sized) )

Replace all occurrences of a regex pattern in stdout with a byte string.

pub fn build_dependencies(&self) -> Result<Vec<OsString>>

Compile dependencies and return the right flags to find the dependencies.

pub fn fill_host_and_target(&mut self) -> Result<()>

Make sure we have the host and target triples.

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.