Skip to main content

NodeKind

Enum NodeKind 

Source
#[non_exhaustive]
pub enum NodeKind {
Show 31 variants Document, Section, Paragraph, Heading { level: u8, }, FencedCodeBlock, IndentedCodeBlock, BlockQuote, BulletList, OrderedList, ListItem, ThematicBreak, HtmlBlock, Table, TableRow, TableHeader, TableDelimiterRow, LinkReferenceDefinition, FrontMatter, Emphasis, StrongEmphasis, InlineCode, Link, Image, Strikethrough, HardLineBreak, SoftLineBreak, InfoString, CodeFenceContent, Inline, Text, Unknown,
}
Expand description

Classification of markdown node types from the tree-sitter CST.

These represent the semantic meaning of each node, useful for rendering decisions and command dispatch.

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.
§

Document

§

Section

§

Paragraph

§

Heading

Fields

§level: u8
§

FencedCodeBlock

§

IndentedCodeBlock

§

BlockQuote

§

BulletList

§

OrderedList

§

ListItem

§

ThematicBreak

§

HtmlBlock

§

Table

§

TableRow

§

TableHeader

§

TableDelimiterRow

§

LinkReferenceDefinition

§

FrontMatter

§

Emphasis

§

StrongEmphasis

§

InlineCode

§

Image

§

Strikethrough

§

HardLineBreak

§

SoftLineBreak

§

InfoString

§

CodeFenceContent

§

Inline

§

Text

§

Unknown

Implementations§

Source§

impl NodeKind

Source

pub fn from_ts_kind(kind: &str) -> Self

Classify a tree-sitter node kind string.

Source

pub fn is_block(&self) -> bool

True if this is a block-level element.

Source

pub fn is_inline(&self) -> bool

True if this is an inline element.

Source

pub fn is_container(&self) -> bool

True if this node can contain other blocks (is a container).

Trait Implementations§

Source§

impl Clone for NodeKind

Source§

fn clone(&self) -> NodeKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeKind

Source§

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

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

impl PartialEq for NodeKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Copy for NodeKind

Source§

impl Eq for NodeKind

Source§

impl StructuralPartialEq for NodeKind

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.