Struct Constructs 

pub struct Constructs {

    pub autolink: bool,
    pub code_indented: bool,
    pub html_flow: bool,
    pub html_text: bool,
    pub gfm_autolink_literal: bool,
    pub gfm_footnote: bool,
    pub gfm_strikethrough: bool,
    pub gfm_strikethrough_single_tilde: bool,
    pub gfm_table: bool,
    pub gfm_task_list_item: bool,
    pub math_flow: bool,
    pub math_text: bool,
    pub liquid: bool,
    pub wiki_link: bool,
    pub container_directive: bool,
    pub mdx_esm: bool,
    pub mdx_expression_flow: bool,
    pub mdx_expression_text: bool,
    pub mdx_jsx_flow: bool,
    pub mdx_jsx_text: bool,
}

Which syntax constructs the parser recognizes.

CommonMark’s core (paragraphs, headings, thematic breaks, blockquotes, lists, fenced code, emphasis, links, hard breaks) is always on. Everything listed here is a construct that some dialect turns off or bolts on.

The default set mirrors Prettier’s parser composition: GFM + math + wiki-link + liquid, plus container directives (:::), which Prettier lacks and consequently corrupts.

Fields

autolink: bool

<https://example.com> / <user@example.com>. Syntax error in MDX.

code_indented: bool

4-space indented code blocks. In MDX the indent is an ordinary paragraph (continuation) instead.

html_flow: bool

HTML blocks (CommonMark types 1–7). In MDX < at flow start is JSX.

html_text: bool

Inline HTML tags/comments. In MDX < in text is JSX.

gfm_autolink_literal: bool

GFM bare-URL links (www.example.com). Printed verbatim.

gfm_footnote: bool

GFM footnotes ([^label]).

gfm_strikethrough: bool

GFM strikethrough (~~x~~).

gfm_strikethrough_single_tilde: bool

Whether a single ~ also opens strikethrough. GitHub and Prettier (singleTilde: false) require ~~; keep this off to leave subscript conventions like H~2~O alone.

gfm_table: bool

GFM tables.

gfm_task_list_item: bool

GFM task list items (- [x]).

math_flow: bool

$$ … $$ display math.

math_text: bool

$ … $ inline math, printed verbatim.

liquid: bool

{% … %} / {{ … }} template tags, multi-line capable. Never interpreted, kept lossless.

wiki_link: bool

[[target]] wiki links, alias-less minimal form, printed verbatim.

container_directive: bool

::: … ::: container directives. Fence lines are kept verbatim (dialects disagree on their grammar); only children are markdown.

mdx_esm: bool

MDX import / export statements at flow start.

mdx_expression_flow: bool

MDX {expr} as its own flow block.

mdx_expression_text: bool

MDX {expr} in text.

mdx_jsx_flow: bool

MDX JSX elements at flow start.

mdx_jsx_text: bool

MDX JSX elements in text.

Implementations

impl Constructs

pub fn markdown() -> Self

Markdown mode: CommonMark + GFM + Prettier’s extensions + directives.

pub fn mdx() -> Self

MDX mode: autolink / code_indented / html_flow / html_text off, the mdx_* family on. Unlike markdown mode, parsing can emit diagnostics (MDX has syntax errors; CommonMark does not).

TODO: Not usable yet: the mdx_* constructs are unimplemented, and disabling code_indented must also lift micromark’s 4-space/3-column indent limits engine-wide (currently hardcoded), so this preset misparses e.g. # hi.

Trait Implementations

impl Clone for Constructs

fn clone(&self) -> Constructs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Constructs

impl Debug for Constructs

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

Formats the value using the given formatter.

impl Default for Constructs

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Constructs

impl PartialEq for Constructs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Constructs