Struct SyntaxOptions 

pub struct SyntaxOptions {
    pub constructs: Constructs,
    pub parse: ParseOptions,
}

A full syntax configuration: which Constructs are recognized plus the ParseOptions lexing knobs. Build one with a preset (commonmark/gfm/ mdx/default), optionally tune it with enable/disable, then call parse.

Fields

constructs: Constructs

Which syntactic constructs are recognized.

parse: ParseOptions

Lexing / source-preservation knobs.

Implementations

impl SyntaxOptions

pub fn commonmark() -> Self

The strict CommonMark dialect.

pub fn gfm() -> Self

GitHub Flavored Markdown (also enables single-tilde strikethrough).

pub fn mdx() -> Self

The MDX dialect (JSX, expressions, ESM; no raw HTML).

pub fn enable(self, construct: Construct) -> Self

Enable a Construct on top of these options, returning the modified options for chaining. Grouped constructs (footnotes, math, directives, …) flip every flag in the group so no member is left silently inert.

pub fn disable(self, construct: Construct) -> Self

Disable a Construct, the inverse of SyntaxOptions::enable.

pub fn validate(&self) -> Result<(), SyntaxConfigError>

Check for contradictory construct combinations (MDX JSX with raw HTML; both wikilink title orders). Returns Ok(()) for every preset; only a hand-built config can trip a SyntaxConfigError.

impl SyntaxOptions

pub fn parse(&self, input: &str) -> ParseOutput

Parse input under these options. Infallible and tolerant: a config conflict (reachable only by hand-building contradictory Constructs) is surfaced as an error diagnostic rather than a hard error. Call SyntaxOptions::validate first for fail-fast config checking.

pub fn parse_strict(&self, input: &str) -> Result<ParseOutput, ParseStrictError>

Parse input, promoting a config conflict or any error-severity diagnostic to a hard ParseStrictError.

Trait Implementations

impl Clone for SyntaxOptions

fn clone(&self) -> SyntaxOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxOptions

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

Formats the value using the given formatter.

impl Default for SyntaxOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SyntaxOptions

impl PartialEq for SyntaxOptions

fn eq(&self, other: &SyntaxOptions) -> 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 StructuralPartialEq for SyntaxOptions