Enum notedown_ast::nodes::ASTKind

source · [−]

pub enum ASTKind {
Show 14 variants
    Statements(ASTNodes),
    Paragraph(ASTNodes),
    Delimiter(Box<Delimiter>),
    Header(Box<Header>),
    TableView(TableView),
    ListView(ListView),
    QuoteNode(Box<QuoteBlock>),
    CodeNode(Box<CodeNode>),
    MathNode(Box<MathNode>),
    LinkNode(SmartLink),
    TextSpan(Box<TextSpan>),
    StyledSpan(Box<StyleNode>),
    Command(Box<Command>),
    Value(Box<Value>),
}

Expand description

ASTKing

Typed info of the Node

Block: Statements, Paragraph
Span: Text, Styled
Node: Code, Math, Link, Command

Notice

If a constructor returns individual elements, then interface accept what is needed (T).

If a constructor returns ASTNode, then the interface implements polymorphic input (impl Into<T>).

Variants

`Statements(ASTNodes)`

Top Scope

`Paragraph(ASTNodes)`

block only

`Delimiter(Box<Delimiter>)`

block only

`Header(Box<Header>)`

block only

`TableView(TableView)`

block only

`ListView(ListView)`

block only

`QuoteNode(Box<QuoteBlock>)`

block only

`CodeNode(Box<CodeNode>)`

block + inline

`MathNode(Box<MathNode>)`

block + inline

`LinkNode(SmartLink)`

block + inline

`TextSpan(Box<TextSpan>)`

inline only

`StyledSpan(Box<StyleNode>)`

inline only

`Command(Box<Command>)`

context sensitive

`Value(Box<Value>)`

never bared

Implementations

impl ASTKind

pub fn command_external<S: Into<String>>(
    cmd: S,
    data: Vec<u8>,
    r: MaybeRanged
) -> ASTNode

Constructor of [ExternalCommand]

impl ASTKind

pub fn as_header(&self) -> Option<Header>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_list_view(&self) -> Option<ListView>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_table_view(&self) -> Option<TableView>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_code(&self) -> Option<CodeNode>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_math(&self) -> Option<MathNode>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_link(&self) -> Option<SmartLink>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_style_span(&self) -> Option<StyleNode>

Returns a copy of the elements, return Option::None if not match this kind.

pub fn as_text_span(&self) -> Option<TextSpan>

Returns a copy of the elements, return Option::None if not match this kind.

impl ASTKind

pub fn code_inline(code: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor of CodeNode

pub fn code_block(
    code: impl Into<String>,
    language: impl Into<String>,
    range: MaybeRanged
) -> ASTNode

Constructor of CodeNode

impl ASTKind

pub fn raw_html_inline(msg: impl Into<String>, range: MaybeRanged) -> ASTNode

Insert raw html text

pub fn raw_html_block(msg: impl Into<String>, range: MaybeRanged) -> ASTNode

Inset raw html block

impl ASTKind

Construct a header node

impl ASTKind

pub fn math_inline(math: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor of MathNode

pub fn math_display(math: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor of MathNode

pub fn math_block(math: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor of MathNode

impl ASTKind

pub fn bold(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn strong(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn italic(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn emphasis(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn italic_bold(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn marking(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn underline(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn undercover(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn delete(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn insert(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn subscript(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

pub fn superscript(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of StyleNode

impl ASTKind

pub fn hard_break(range: MaybeRanged) -> ASTNode

Aka. <br>

pub fn soft_break(range: MaybeRanged) -> ASTNode

Aka. \n

pub fn text(s: impl Into<String>, range: MaybeRanged) -> ASTNode

pub fn text_raw(s: impl Into<String>, range: MaybeRanged) -> ASTNode

pub fn escaped(text: &str, range: MaybeRanged) -> Result<ASTNode>

Constructor of TextSpan::Escaped

pub fn escaped_char(c: char, range: MaybeRanged) -> ASTNode

Constructor of TextSpan::Escaped

pub fn escaped_html(_: char, _: MaybeRanged) -> Result<ASTNode>

Constructor of TextSpan::Normal

pub fn emoji(text: &str, range: MaybeRanged) -> Result<ASTNode>

Constructor of TextSpan::Emoji

impl ASTKind

pub fn image_link(src: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor for ImageLink

pub fn image_link_alt(
    src: impl Into<String>,
    alt: impl Into<String>,
    range: MaybeRanged
) -> ASTNode

Constructor for ImageLink

pub fn hyper_link(src: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor for HyperLink

pub fn hyper_link_text(
    src: impl Into<String>,
    text: impl Into<String>,
    range: MaybeRanged
) -> ASTNode

Constructor for HyperLink

pub fn bare_link(src: impl Into<String>, range: MaybeRanged) -> ASTNode

Constructor for HyperLink

impl ASTKind

pub fn ordered_list(children: Vec<ListItem>, r: MaybeRanged) -> ASTNode

Constructor of OrderedList

pub fn orderless_list(children: Vec<ListItem>, r: MaybeRanged) -> ASTNode

Constructor of OrderlessList

impl ASTKind

pub fn quote(body: ASTNodes, r: MaybeRanged) -> ASTNode

Constructor of QuoteBlock

pub fn quote_style(
    body: ASTNodes,
    style: impl Into<String>,
    r: MaybeRanged
) -> ASTNode

Constructor of QuoteBlock

impl ASTKind

pub fn statements(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of ASTKind::Statements

pub fn paragraph(children: ASTNodes, range: MaybeRanged) -> ASTNode

Constructor of ASTKind::Paragraph

pub fn hr(range: MaybeRanged) -> ASTNode

Constructor of Delimiter::HorizontalRule

Trait Implementations

impl Clone for ASTKind

fn clone(&self) -> ASTKind

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl ContextAware for ASTKind

fn context_aware(&self, offset: u32) -> ContextKind

Aware the context in which the cursor is located

impl Debug for ASTKind

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

Formats the value using the given formatter. Read more

impl Default for ASTKind

fn default() -> Self

Returns the “default value” for a type. Read more

impl Display for ASTKind

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

Formats the value using the given formatter. Read more

impl Hash for ASTKind

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl Into<ASTKind> for CodeNode

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for Command

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for Delimiter

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for Header

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for HyperLink

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for ImageLink

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for ListView

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for MathNode

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for OrderedList

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for OrderlessList

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for QuoteBlock

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for SimpleTable

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for SmartLink

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for StyleNode

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for TableView

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for TextSpan

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<ASTKind> for Value

fn into(self) -> ASTKind

Converts this type into the (usually inferred) input type.

impl Into<Literal<ASTKind>> for ASTKind

fn into(self) -> ASTNode

Converts this type into the (usually inferred) input type.

impl IntoASTNode for ASTKind

fn into_node(self, range: MaybeRanged) -> ASTNode

Convert element into ASTNode with position

impl PartialEq<ASTKind> for ASTKind

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl Slugify for ASTKind

fn slugify(&self) -> String

Slugify the element of notedown

impl Eq for ASTKind

impl StructuralEq for ASTKind

impl StructuralPartialEq for ASTKind

Auto Trait Implementations

impl RefUnwindSafe for ASTKind

impl Send for ASTKind

impl Sync for ASTKind

impl Unpin for ASTKind

impl UnwindSafe for ASTKind

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for Twhere
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.