Skip to main content

Node

Enum Node

pub enum Node {
Show 30 variants
    Text(TextNode),
    CodeInline(CodeInlineNode),
    CodeBlock(CodeBlockNode),
    Paragraph(StandardBlockNode),
    Heading(StandardBlockNode),
    List(StandardBlockNode),
    ListItem(StandardBlockNode),
    Blockquote(StandardBlockNode),
    ThematicBreak(StandardBlockNode),
    Html(StandardBlockNode),
    Table(StandardBlockNode),
    TableRow(StandardBlockNode),
    TableCell(StandardBlockNode),
    Link(LinkNode),
    Image(ImageNode),
    Emphasis(StandardBlockNode),
    Strong(StandardBlockNode),
    Strikethrough(StandardBlockNode),
    DefinitionList(StandardBlockNode),
    DefinitionTerm(StandardBlockNode),
    DefinitionDescription(StandardBlockNode),
    FootnoteDefinition(FootnoteNode),
    FootnoteReference(FootnoteNode),
    MathInline(MathNode),
    MathDisplay(MathDisplayNode),
    Citation(CitationNode),
    CrossRef(CrossRefNode),
    Component(ComponentNode),
    Variable(VariableNode),
    Error(ErrorNode),
}

Expand description

A union of all possible RDX nodes.

Variants§

Text(TextNode)

CodeInline(CodeInlineNode)

CodeBlock(CodeBlockNode)

Paragraph(StandardBlockNode)

Heading(StandardBlockNode)

List(StandardBlockNode)

ListItem(StandardBlockNode)

Blockquote(StandardBlockNode)

ThematicBreak(StandardBlockNode)

Html(StandardBlockNode)

Table(StandardBlockNode)

TableRow(StandardBlockNode)

TableCell(StandardBlockNode)

Link(LinkNode)

Image(ImageNode)

Emphasis(StandardBlockNode)

Strong(StandardBlockNode)

Strikethrough(StandardBlockNode)

DefinitionList(StandardBlockNode)

DefinitionTerm(StandardBlockNode)

DefinitionDescription(StandardBlockNode)

FootnoteDefinition(FootnoteNode)

FootnoteReference(FootnoteNode)

MathInline(MathNode)

MathDisplay(MathDisplayNode)

Citation(CitationNode)

CrossRef(CrossRefNode)

Component(ComponentNode)

Variable(VariableNode)

Error(ErrorNode)

Implementations§

impl Node

pub fn children_mut(&mut self) -> Option<&mut Vec<Node>>

Returns a mutable reference to this node’s children, if it has any.

pub fn children(&self) -> Option<&[Node]>

Returns a reference to this node’s children, if it has any.

Trait Implementations§

impl Archive for Node

type Archived = ArchivedNode

The archived representation of this type. Read more

type Resolver = NodeResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <Node as Archive>::Resolver, out: Place<<Node as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output. Read more

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize. Read more

impl Clone for Node

fn clone(&self) -> Node

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

impl Debug for Node

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Node

fn deserialize<D>( deserializer: D, ) -> Result<Node, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<D> Deserialize<Node, D> for <Node as Archive>::Archived
where D: Fallible + ?Sized, <D as Fallible>::Error: Source,

fn deserialize( &self, deserializer: &mut D, ) -> Result<Node, <D as Fallible>::Error>

Deserializes using the given deserializer

impl PartialEq for Node

fn eq(&self, other: &Node) -> 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.

impl<S> Serialize<S> for Node
where S: Fallible + Writer + Allocator + ?Sized, <S as Fallible>::Error: Source,

fn serialize( &self, serializer: &mut S, ) -> Result<<Node as Archive>::Resolver, <S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for Node

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Node

Auto Trait Implementations§

impl Freeze for Node

impl RefUnwindSafe for Node

impl Send for Node

impl Sync for Node

impl Unpin for Node

impl UnsafeUnpin for Node

impl UnwindSafe for Node

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T> ArchiveUnsized for T
where T: Archive,

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.

impl<T> ToOwned for T
where 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, U> TryFrom<U> for T
where 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>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,