Skip to main content

NodeKind

Enum NodeKind 

Source
pub enum NodeKind {
Show 22 variants Document, Section, Paragraph, Text, Emphasis, Strong, BoldItalic, Math, Equation, Figure, Image, Table, Citation, Reference, PageReference, Theorem, Footnote, Bibliography, Raw, List, ListItem, HardBreak,
}
Expand description

The kinds of nodes Mosaic recognises (manifest §5.1).

§Examples

use mos_core::NodeKind;

let kind = NodeKind::Paragraph;

assert_eq!(kind, NodeKind::Paragraph);

Variants§

§

Document

§

Section

§

Paragraph

§

Text

§

Emphasis

§

Strong

§

BoldItalic

§

Math

§

Equation

§

Figure

A captioned container: an image plus a caption paragraph, laid out together with the caption beneath. Cross-references via @fig:foo will target this kind once MVP 3 lands.

§

Image

A raster image (PNG / JPEG in MVP 1.5). The decoded pixel data and natural dimensions live on the node’s attributes; see the mos-eval resolver for the exact attribute names.

§

Table

§

Citation

§

Reference

§

PageReference

A @page(label) reference to the printed page number of a labelled target. Distinct from Reference (which resolves to a section/figure number): a page reference resolves to where the target lands, which is only known after layout, via the resolve↔layout fixpoint (issue #72). Carries a label attribute and placeholder text; layout renders the text attribute like any inline run.

§

Theorem

§

Footnote

§

Bibliography

§

Raw

§

List

A bullet or numbered list. The ordered attribute distinguishes the two kinds and child nodes are NodeKind::ListItems.

§

ListItem

One entry inside a NodeKind::List. Paragraph children carry item text; nested NodeKind::List children describe deeper levels.

§

HardBreak

\\: a forced line break inside a paragraph. Carries no attributes; layout consumes it as a WordItem::HardBreak sentinel in the inline word stream. A blank-line paragraph break is not the same node: it ends the paragraph and triggers paragraph-spacing leading, whereas HardBreak keeps the same paragraph and applies normal inter-line leading.

Trait Implementations§

Source§

impl Clone for NodeKind

Source§

fn clone(&self) -> NodeKind

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NodeKind

Source§

impl Debug for NodeKind

Source§

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

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

impl Eq for NodeKind

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