Struct Constructs 

pub struct Constructs {

    pub attention: bool,
    pub autolink: bool,
    pub block_quote: bool,
    pub character_escape: bool,
    pub character_reference: bool,
    pub code_indented: bool,
    pub code_fenced: bool,
    pub code_text: bool,
    pub definition: bool,
    pub frontmatter: bool,
    pub autolink_literal: bool,
    pub footnote_definition: bool,
    pub label_start_footnote: bool,
    pub strikethrough: bool,
    pub table: bool,
    pub task_list_item: bool,
    pub hard_break_escape: bool,
    pub hard_break_trailing: bool,
    pub heading_atx: bool,
    pub heading_setext: bool,
    pub html_flow: bool,
    pub html_text: bool,
    pub label_start_image: bool,
    pub label_start_link: bool,
    pub label_end: bool,
    pub list_item: bool,
    pub math_flow: bool,
    pub math_text: bool,
    pub thematic_break: bool,
}

Control which constructs are enabled.

Not all constructs can be configured. Notably, blank lines and paragraphs cannot be turned off.

Examples

use base_markdown::Constructs;

// Use the default trait to get `CommonMark` constructs:
let commonmark = Constructs::default();

// To turn on all of GFM, use the `gfm` method:
let gfm = Constructs::gfm();

// Or, mix and match:
let custom = Constructs {
  math_flow: true,
  math_text: true,
  ..Constructs::gfm()
};

Fields

attention: bool

Attention.

> | a *b* c **d**.
      ^^^   ^^^^^

autolink: bool

Autolink.

> | a <https://example.com> b <user@example.org>.
      ^^^^^^^^^^^^^^^^^^^^^   ^^^^^^^^^^^^^^^^^^

block_quote: bool

Block quote.

> | > a
    ^^^

character_escape: bool

Character escape.

> | a \* b
      ^^

character_reference: bool

Character reference.

> | a & b
      ^^^^^

code_indented: bool

Code (indented).

> |     a
    ^^^^^

code_fenced: bool

Code (fenced).

> | ~~~js
    ^^^^^
> | console.log(1)
    ^^^^^^^^^^^^^^
> | ~~~
    ^^^

code_text: bool

Code (text).

> | a `b` c
      ^^^

definition: bool

Definition.

> | [a]: b "c"
    ^^^^^^^^^^

frontmatter: bool

Frontmatter with an unindented opening fence on the first document line, outside list items and blockquotes, and a matching closing fence.

All forms produce a source-backed opaque node with NodeSyntax::Frontmatter metadata. Untagged --- and +++ imply YAML and TOML. A format hint after either delimiter, or a language-tagged backtick/tilde code fence, supplies an explicit language. The parser preserves the raw body and authored info string; HTML omits the frontmatter.

> | ---
    ^^^
> | title: Neptune
    ^^^^^^^^^^^^^^
> | ---
    ^^^

autolink_literal: bool

Autolink literal.

> | https://example.com
    ^^^^^^^^^^^^^^^^^^^

footnote_definition: bool

Footnote definition.

> | [^a]: b
    ^^^^^^^

label_start_footnote: bool

Footnote label start.

> | a[^b]
     ^^

strikethrough: bool

Strikethrough.

> | a ~b~ c.
      ^^^

table: bool

Table.

> | | a |
    ^^^^^
> | | - |
    ^^^^^
> | | b |
    ^^^^^

task_list_item: bool

Task list item.

> | * [x] y.
      ^^^

hard_break_escape: bool

Hard break (escape).

> | a\
     ^
  | b

hard_break_trailing: bool

Hard break (trailing).

> | a␠␠
     ^^
  | b

heading_atx: bool

Heading (atx).

> | # a
    ^^^

heading_setext: bool

Heading (setext).

> | a
    ^^
> | ==
    ^^

html_flow: bool

HTML (flow).

> | <div>
    ^^^^^

html_text: bool

HTML (text).

> | a <b> c
      ^^^

label_start_image: bool

Label start (image).

> | a ![b](c) d
      ^^

label_start_link: bool

Label start (link).

> | a [b](c) d
      ^

label_end: bool

Label end.

> | a [b](c) d
        ^^^^

list_item: bool

List items.

> | * a
    ^^^

math_flow: bool

Math (flow).

> | $$
    ^^
> | \frac{1}{2}
    ^^^^^^^^^^^
> | $$
    ^^

math_text: bool

Math (text).

> | a $b$ c
      ^^^

thematic_break: bool

Thematic break.

> | ***
    ^^^

Implementations

impl Constructs

pub fn gfm() -> Self

GFM.

GFM stands for GitHub flavored markdown. GFM extends CommonMark and adds support for autolink literals, footnotes, strikethrough, tables, and tasklists.

For more information, see the GFM specification: https://github.github.com/gfm/.

Trait Implementations

impl Clone for Constructs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

CommonMark.

CommonMark is a relatively strong specification of how markdown works. Most markdown parsers try to follow it.

For more information, see the CommonMark specification: https://spec.commonmark.org.

impl Eq for Constructs

impl PartialEq for Constructs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Constructs