Struct Options 

#[non_exhaustive]
pub struct Options {
    pub match_case: bool,
    pub strip_inline_markup: bool,
    pub allow_skipped_levels: bool,
    pub ordered_sections: bool,
}

Options controlling Markdown parsing and matcher behavior.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

match_case: bool

Whether all matcher forms compare text case-sensitively.

strip_inline_markup: bool

Whether inline Markdown is reduced to its text before matching.

allow_skipped_levels: bool

Whether a header may be more than one level below its parent.

ordered_sections: bool

Whether a scope’s rules bind in document order unless a rule’s own ordered says otherwise (specification §3.7).

Implementations

impl Options

pub const fn with_match_case(self, match_case: bool) -> Self

Sets case sensitivity for every matcher form.

pub const fn with_strip_inline_markup(self, strip_inline_markup: bool) -> Self

Sets whether inline Markdown is reduced to visible text for matching.

pub const fn with_allow_skipped_levels(self, allow_skipped_levels: bool) -> Self

Sets whether headings may skip a level in the document tree.

pub const fn with_ordered_sections(self, ordered_sections: bool) -> Self

Sets the default for whether each scope’s rules bind in document order.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Options

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

Uses the defaults defined by specification §7.

impl Eq for Options

impl PartialEq for Options

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Options