Struct CheckOptions 

pub struct CheckOptions {
    pub all: bool,
    pub disable_website_checks: bool,
    pub exit_on_first_error: bool,
    pub offline: bool,
    pub quiet: bool,
    pub no_fail: bool,
    pub skip: Vec<String>,
    pub standard: Standard,
    pub readability_metric: ReadabilityType,
    pub skip_verify_checksum: bool,
    pub terse: bool,
    pub vale_config: Option<ValeConfig>,
}

Data structure for passing options to check processing functions

Fields

all: bool

Include non-failure results such as suggestions and info messages

disable_website_checks: bool

Disable website checks that require internet access

exit_on_first_error: bool

Flag used to indicate if a single error should cause the process to exit

offline: bool

Whether or not to run in offline mode (i.e., skip website checks)

quiet: bool

Suppress stdout/stderr from external commands (e.g., Vale sync)

no_fail: bool

Prevent non-zero exit behavior when failures are present

skip: Vec<String>

Categories of checks to skip during processing

standard: Standard

Metadata standard used to resolve check processing behavior

readability_metric: ReadabilityType

Readability metric to use for readability checks

skip_verify_checksum: bool

Whether or not to skip checksum verification for prose analysis

terse: bool

Use compact output format instead of detailed output

vale_config: Option<ValeConfig>

Vale configuration options

Implementations

impl CheckOptions

pub fn init() -> CheckOptionsBuilder

Create an instance of CheckOptions using the builder syntax

Trait Implementations

impl Clone for CheckOptions

fn clone(&self) -> CheckOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckOptions

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

Formats the value using the given formatter.

impl Default for CheckOptions

fn default() -> CheckOptions

Returns the “default value” for a type.