Struct BeginOptions 

pub struct BeginOptions {
    pub rule_ids: Vec<String>,
    pub language: Option<String>,
    pub doc_type: Option<String>,
    pub line_slice: Option<(usize, usize)>,
    pub match_pattern: Option<String>,
    pub exclude_pattern: Option<String>,
}

Options for a lang-check-begin directive.

Fields

rule_ids: Vec<String>

Only suppress these rule IDs; if empty, suppress all.

language: Option<String>

Override natural language for this region (e.g. “fr”, “de”).

doc_type: Option<String>

Re-parse region as this format (e.g. “latex”). Deferred implementation.

line_slice: Option<(usize, usize)>

Scope applies to a slice of lines after the directive (no end directive needed). (start, end) in 0-indexed line offsets, like Python slice notation [start:end].

match_pattern: Option<String>

Only apply to lines matching this regex pattern.

exclude_pattern: Option<String>

Skip lines matching this regex pattern.

Trait Implementations

impl Clone for BeginOptions

fn clone(&self) -> BeginOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeginOptions

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

Formats the value using the given formatter.

impl Default for BeginOptions

fn default() -> BeginOptions

Returns the “default value” for a type.

impl PartialEq for BeginOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BeginOptions

impl StructuralPartialEq for BeginOptions