oak-markdown 0.0.11

High-performance incremental Markdown parser for the oak ecosystem with flexible configuration, optimized for documentation and content creation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

use oak_core::{ElementType, UniversalElementRole};

/// Element types for the Markdown language.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(u16)]
pub enum MarkdownElementType {
    /// The root of the document.
    Root,
    /// A paragraph of text.
    Paragraph,
    /// A table.
    Table,
    /// Heading level 1.
    Heading1,
    /// Heading level 2.
    Heading2,
    /// Heading level 3.
    Heading3,
    /// Heading level 4.
    Heading4,
    /// Heading level 5.
    Heading5,
    /// Heading level 6.
    Heading6,
    /// A blockquote.
    Blockquote,
    /// A code block.
    CodeBlock,
    /// A list.
    List,
    /// A list item.
    ListItem,
    /// A horizontal rule.
    HorizontalRule,
    /// A math block.
    MathBlock,
    /// Front matter.
    FrontMatter,
    /// A footnote definition.
    FootnoteDefinition,
    /// Plain text.
    Text,
    /// Whitespace.
    Whitespace,
    /// A newline.
    Newline,
    /// The text of a heading.
    HeadingText,
    /// Emphasized text.
    Emphasis,
    /// Strong text.
    Strong,
    /// Strikethrough text.
    Strikethrough,
    /// Inline code.
    InlineCode,
    /// A code fence.
    CodeFence,
    /// A code language identifier.
    CodeLanguage,
    /// A link.
    Link,
    /// The text of a link.
    LinkText,
    /// The URL of a link.
    LinkUrl,
    /// The title of a link.
    LinkTitle,
    /// An image.
    Image,
    /// The alt text of an image.
    ImageAlt,
    /// The URL of an image.
    ImageUrl,
    /// The title of an image.
    ImageTitle,
    /// An unordered list.
    UnorderedList,
    /// An ordered list.
    OrderedList,
    /// A list marker.
    ListMarker,
    /// A task list.
    TaskList,
    /// A task marker.
    TaskMarker,
    /// A blockquote marker.
    BlockquoteMarker,
    /// A table row.
    TableRow,
    /// A table cell.
    TableCell,
    /// A table header cell.
    TableHeader,
    /// A table separator.
    TableSeparator,
    /// Table alignment information.
    TableAlignment,
    /// Inline math.
    MathInline,
    /// A footnote reference.
    FootnoteReference,
    /// A definition list.
    DefinitionList,
    /// A definition term.
    DefinitionTerm,
    /// A definition description.
    DefinitionDescription,
    /// Superscript text.
    Superscript,
    /// Subscript text.
    Subscript,
    /// An abbreviation.
    Abbreviation,
    /// An HTML tag.
    HtmlTag,
    /// An HTML comment.
    HtmlComment,
    /// An XML tag.
    XmlTag,
    /// An XML comment.
    XmlComment,
    /// An automatic link (HTTP/HTTPS URL).
    AutoLink,
    /// An error element.
    Error,
}

impl ElementType for MarkdownElementType {
    type Role = UniversalElementRole;

    fn role(&self) -> Self::Role {
        match self {
            _ => UniversalElementRole::None,
        }
    }
}

impl From<crate::lexer::token_type::MarkdownTokenType> for MarkdownElementType {
    fn from(token: crate::lexer::token_type::MarkdownTokenType) -> Self {
        match token {
            crate::lexer::token_type::MarkdownTokenType::Text => MarkdownElementType::Text,
            crate::lexer::token_type::MarkdownTokenType::Whitespace => MarkdownElementType::Whitespace,
            crate::lexer::token_type::MarkdownTokenType::Newline => MarkdownElementType::Newline,
            crate::lexer::token_type::MarkdownTokenType::Heading1 => MarkdownElementType::Heading1,
            crate::lexer::token_type::MarkdownTokenType::Heading2 => MarkdownElementType::Heading2,
            crate::lexer::token_type::MarkdownTokenType::Heading3 => MarkdownElementType::Heading3,
            crate::lexer::token_type::MarkdownTokenType::Heading4 => MarkdownElementType::Heading4,
            crate::lexer::token_type::MarkdownTokenType::Heading5 => MarkdownElementType::Heading5,
            crate::lexer::token_type::MarkdownTokenType::Heading6 => MarkdownElementType::Heading6,
            crate::lexer::token_type::MarkdownTokenType::HeadingText => MarkdownElementType::HeadingText,
            crate::lexer::token_type::MarkdownTokenType::Emphasis => MarkdownElementType::Emphasis,
            crate::lexer::token_type::MarkdownTokenType::Strong => MarkdownElementType::Strong,
            crate::lexer::token_type::MarkdownTokenType::Strikethrough => MarkdownElementType::Strikethrough,
            crate::lexer::token_type::MarkdownTokenType::InlineCode => MarkdownElementType::InlineCode,
            crate::lexer::token_type::MarkdownTokenType::CodeBlock => MarkdownElementType::CodeBlock,
            crate::lexer::token_type::MarkdownTokenType::CodeFence => MarkdownElementType::CodeFence,
            crate::lexer::token_type::MarkdownTokenType::CodeLanguage => MarkdownElementType::CodeLanguage,
            crate::lexer::token_type::MarkdownTokenType::Link => MarkdownElementType::Link,
            crate::lexer::token_type::MarkdownTokenType::LinkText => MarkdownElementType::LinkText,
            crate::lexer::token_type::MarkdownTokenType::LinkUrl => MarkdownElementType::LinkUrl,
            crate::lexer::token_type::MarkdownTokenType::LinkTitle => MarkdownElementType::LinkTitle,
            crate::lexer::token_type::MarkdownTokenType::Image => MarkdownElementType::Image,
            crate::lexer::token_type::MarkdownTokenType::ImageAlt => MarkdownElementType::ImageAlt,
            crate::lexer::token_type::MarkdownTokenType::ImageUrl => MarkdownElementType::ImageUrl,
            crate::lexer::token_type::MarkdownTokenType::ImageTitle => MarkdownElementType::ImageTitle,
            crate::lexer::token_type::MarkdownTokenType::UnorderedList => MarkdownElementType::UnorderedList,
            crate::lexer::token_type::MarkdownTokenType::OrderedList => MarkdownElementType::OrderedList,
            crate::lexer::token_type::MarkdownTokenType::ListItem => MarkdownElementType::ListItem,
            crate::lexer::token_type::MarkdownTokenType::ListMarker => MarkdownElementType::ListMarker,
            crate::lexer::token_type::MarkdownTokenType::TaskList => MarkdownElementType::TaskList,
            crate::lexer::token_type::MarkdownTokenType::TaskMarker => MarkdownElementType::TaskMarker,
            crate::lexer::token_type::MarkdownTokenType::Blockquote => MarkdownElementType::Blockquote,
            crate::lexer::token_type::MarkdownTokenType::BlockquoteMarker => MarkdownElementType::BlockquoteMarker,
            crate::lexer::token_type::MarkdownTokenType::HorizontalRule => MarkdownElementType::HorizontalRule,
            crate::lexer::token_type::MarkdownTokenType::Table => MarkdownElementType::Table,
            crate::lexer::token_type::MarkdownTokenType::TableRow => MarkdownElementType::TableRow,
            crate::lexer::token_type::MarkdownTokenType::TableCell => MarkdownElementType::TableCell,
            crate::lexer::token_type::MarkdownTokenType::TableHeader => MarkdownElementType::TableHeader,
            crate::lexer::token_type::MarkdownTokenType::TableSeparator => MarkdownElementType::TableSeparator,
            crate::lexer::token_type::MarkdownTokenType::TableAlignment => MarkdownElementType::TableAlignment,
            crate::lexer::token_type::MarkdownTokenType::MathInline => MarkdownElementType::MathInline,
            crate::lexer::token_type::MarkdownTokenType::MathBlock => MarkdownElementType::MathBlock,
            crate::lexer::token_type::MarkdownTokenType::FootnoteDefinition => MarkdownElementType::FootnoteDefinition,
            crate::lexer::token_type::MarkdownTokenType::FootnoteReference => MarkdownElementType::FootnoteReference,
            crate::lexer::token_type::MarkdownTokenType::FrontMatter => MarkdownElementType::FrontMatter,
            crate::lexer::token_type::MarkdownTokenType::DefinitionList => MarkdownElementType::DefinitionList,
            crate::lexer::token_type::MarkdownTokenType::DefinitionTerm => MarkdownElementType::DefinitionTerm,
            crate::lexer::token_type::MarkdownTokenType::DefinitionDescription => MarkdownElementType::DefinitionDescription,
            crate::lexer::token_type::MarkdownTokenType::Superscript => MarkdownElementType::Superscript,
            crate::lexer::token_type::MarkdownTokenType::Subscript => MarkdownElementType::Subscript,
            crate::lexer::token_type::MarkdownTokenType::Abbreviation => MarkdownElementType::Abbreviation,
            crate::lexer::token_type::MarkdownTokenType::HtmlTag => MarkdownElementType::HtmlTag,
            crate::lexer::token_type::MarkdownTokenType::HtmlComment => MarkdownElementType::HtmlComment,
            crate::lexer::token_type::MarkdownTokenType::XmlTag => MarkdownElementType::XmlTag,
            crate::lexer::token_type::MarkdownTokenType::XmlComment => MarkdownElementType::XmlComment,
            crate::lexer::token_type::MarkdownTokenType::AutoLink => MarkdownElementType::AutoLink,
            crate::lexer::token_type::MarkdownTokenType::Error => MarkdownElementType::Error,
            _ => MarkdownElementType::Error,
        }
    }
}