[−][src]Enum comrak::nodes::NodeValue
The core AST node enum.
Variants
The root of every CommonMark document. Contains blocks.
Block. A block quote. Contains other blocks.
> A block quote.
List(NodeList)
Block. A list. Contains list items.
* An unordered list
* Another item
1. An ordered list
2. Another item
Item(NodeList)
Block. A list item. Contains other blocks.
Block. A description list, enabled with ext_description_lists
option. Contains
description items.
It is required to put a blank line between terms and details.
Term 1
: Details 1
Term 2
: Details 2
DescriptionItem(NodeDescriptionItem)
Block*. An item of a description list. Contains a term and one details block.
Block. Term of an item in a definition list.
Block. Details of an item in a definition list.
CodeBlock(NodeCodeBlock)
Block. A code block; may be fenced or indented. Contains raw text which is not parsed as Markdown, although is HTML escaped.
HtmlBlock(NodeHtmlBlock)
Block. A HTML block. Contains raw text which is neither parsed as Markdown nor HTML escaped.
Block. A paragraph. Contains inlines.
Heading(NodeHeading)
Block. A heading; may be an ATX heading or a setext heading. Contains inlines.
Block. A thematic break. Has no children.
Block. A footnote definition. The Vec<u8>
is the footnote's name.
Contains other blocks.
Table(Vec<TableAlignment>)
Block. A table per the GFM spec. Contains table rows.
TableRow(bool)
Block. A table row. The bool
represents whether the row is the header row or not.
Contains table cells.
Block. A table cell. Contains inlines.
Inline. Textual content. All text
in a document will be contained in a Text
node.
TaskItem(bool)
Inline. Task list item. The
bool
indicates whether it is checked or not.
Inline. A soft line break. If
the hardbreaks
option is set in ComrakOptions
during formatting, it will be formatted
as a LineBreak
.
Inline. A hard line break.
Inline. A code span.
Inline. Raw HTML contained inline.
Inline. Emphasised text.
Inline. Strong text.
Inline. Strikethrough text per the GFM spec.
Inline. Superscript. Enabled with ext_superscript
option.
Link(NodeLink)
Inline. A link to some URL, with possible title.
Image(NodeLink)
Inline. An image.
Inline. A footnote reference; the Vec<u8>
is the referent footnote's name.
Implementations
impl NodeValue
[src]
pub fn block(&self) -> bool
[src]
Indicates whether this node is a block node or inline node.
pub fn contains_inlines(&self) -> bool
[src]
Indicates whether this node may contain inlines.
pub fn text(&self) -> Option<&Vec<u8>>
[src]
Return a reference to the text of a Text
inline, if this node is one.
Convenience method.
pub fn text_mut(&mut self) -> Option<&mut Vec<u8>>
[src]
Return a mutable reference to the text of a Text
inline, if this node is one.
Convenience method.
Trait Implementations
impl Clone for NodeValue
[src]
impl Debug for NodeValue
[src]
impl<'a> From<NodeValue> for AstNode<'a>
[src]
Auto Trait Implementations
impl RefUnwindSafe for NodeValue
impl Send for NodeValue
impl Sync for NodeValue
impl Unpin for NodeValue
impl UnwindSafe for NodeValue
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,