Struct Options 

pub struct Options {

    pub allow_empty: bool,
    pub check_prefixes: Vec<Symbol>,
    pub comment_prefixes: Vec<Symbol>,
    pub allow_unused_prefixes: bool,
    pub strict_whitespace: bool,
    pub match_full_lines: bool,
    pub ignore_case: bool,
    pub implicit_check_not: Vec<Symbol>,
    pub dump_input: Dump,
    pub dump_input_filter: DumpFilter,
    pub enable_var_scope: bool,
    pub variables: Vec<CliVariable>,
    pub verbose: u8,
    pub color: ColorChoice,
}

FileCheck reads two files, one from standard input, and one specified on the command line; and uses one to verify the other.

Fields

allow_empty: bool

Allow checking empty input. By default, empty input is rejected.

check_prefixes: Vec<Symbol>

Which prefixes to treat as directives.

For example, in the directive CHECK-SAME, CHECK is the prefix.

comment_prefixes: Vec<Symbol>

Which prefixes to treat as comments.

All content on a line following a comment directive is ignored, up to the next newline.

allow_unused_prefixes: bool

If specifying multiple check prefixes, this controls whether or not to raise an error if one of the prefixes is missing in the test file.

strict_whitespace: bool

Disable default canonicalization of whitespace.

By default, FileCheck canonicalizes horizontal whitespace (spaces and tabs) which causes it to ignore these differences (a space will match a tab).

This flag disables horizontal whitespace canonicalization.

Newlines are always canonicalized to LF regardless of this setting.

match_full_lines: bool

This flag changes the default matching behavior to require all positive matches to cover an entire line. Leading/trailing whitespace is ignored unless --strict-whitespace is also specified.

By default, FileCheck allows matches of anywhere on a line, so by setting this, you effectively insert {{^.*}} or {{^}} before, and {{[*$]}} or {{$}} after every positive check pattern.

NOTE Negative matches, i.e CHECK-NOT are not affected by this option.

ignore_case: bool

Disable case-sensitive matching

implicit_check_not: Vec<Symbol>

Adds implicit negative checks for the specified patterns between positive checks.

This option allows writing stricter tests without polluting them with CHECK-NOTs.

For example, --implicit-check-not warning: can be useful when testing diagnostic messages from tools that don’t have an option similar to clang -verify. With this option FileCheck will verify that input does not contain warnings not covered by any CHECK: patterns.

dump_input: Dump

Dump input to stderr, adding annotations representing currently enabled diagnostics.

dump_input_filter: DumpFilter

Specify the parts of the input to dump when --dump-input is set.

When specified, print only input lines of KIND, plus any context specified by --dump-input-context.

Defaults to error when --dump-input=fail, and all when --dump-input=always

enable_var_scope: bool

Enables scope for regex variables

Variables with names that start with $ are considered global, and remain set throughout the file

All other variables get undefined after each encountered CHECK-LABEL

variables: Vec<CliVariable>

Set a pattern variable VAR with value VALUE that can be used in CHECK: lines

You must specify each one in key=value format

verbose: u8

Set the verbosity level.

If specified a single time, it causes filecheck to print good directive pattern matches

If specified multiple times, filecheck will emit internal diagnostics to aid in troubleshooting.

If --dump-input=fail or --dump-input=always, add information as input annotations instead.

color: ColorChoice

Whether, and how, to color terminal output

Implementations

impl Options

pub fn validate(&self) -> DiagResult<()>

Trait Implementations

impl Args for Options

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Options

This is implemented for Options so that we can use clap::Parser::update_from on it.

fn command() -> Command

Build a Command that can instantiate Self.

fn command_for_update() -> Command

Build a Command that can update self.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for Options

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Options

This is implemented for Options in order to use clap::Parser::update_from.

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.