Skip to main content

Construct

Enum Construct 

Source
#[non_exhaustive]
pub enum Construct {
Show 21 variants Table, TaskList, Strikethrough, Autolink, Alert, Footnotes, Math, Frontmatter, Underline, Insert, Highlight, Subscript, Superscript, Spoiler, Shortcode, DescriptionList, Wikilinks(WikiLinkOrder), MdxJsx, MdxExpressions, MdxEsm, Directives,
}
Expand description

A discoverable, typo-proof front door for toggling a syntax feature via SyntaxOptions::enable / SyntaxOptions::disable. Each variant maps to one conceptual feature; grouped features flip every underlying Constructs flag together. The raw Constructs struct remains the exhaustive escape hatch for fine-grained control.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Table

GFM pipe tables: | a | b | over |---|---|.

§

TaskList

GFM task list items: - [ ] / - [x].

§

Strikethrough

Strikethrough: ~~text~~.

GFM literal autolinks plus the cmark relaxed scheme:// extension.

§

Alert

GFM alerts: > [!NOTE] callouts.

§

Footnotes

Footnote definitions, references, and inline footnotes.

§

Math

Inline and block math.

§

Frontmatter

A leading ---/+++ frontmatter block.

§

Underline

Underline: __text__ (overrides CommonMark strong).

§

Insert

Insertions: ++text++.

§

Highlight

Highlight / mark: ==text==.

§

Subscript

Subscript: ~text~.

§

Superscript

Superscript: ^text^.

§

Spoiler

Spoilers: ||text||.

§

Shortcode

Emoji-style shortcodes: :tada:.

§

DescriptionList

Description / definition lists.

Wikilinks [[…]] with the given title order.

§

MdxJsx

MDX JSX (block and inline). Conflicts with raw HTML; pair with disable-ing HTML or start from SyntaxOptions::mdx.

§

MdxExpressions

MDX {…} expressions (block and inline).

§

MdxEsm

MDX ESM import/export lines.

§

Directives

The :name / ::name / :::name directive family.

Trait Implementations§

Source§

impl Clone for Construct

Source§

fn clone(&self) -> Construct

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Construct

Source§

impl Debug for Construct

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Construct

Source§

impl PartialEq for Construct

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Construct

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.