Enum Inline 

pub enum Inline {
    Text {
        id: NodeId,
        value: String,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Break {
        id: NodeId,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Emphasis {
        id: NodeId,
        children: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Strong {
        id: NodeId,
        children: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Code {
        id: NodeId,
        value: String,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Link {
        id: NodeId,
        url: String,
        children: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Note {
        id: NodeId,
        blocks: Vec<Block>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Strikethrough {
        id: NodeId,
        children: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Span {
        id: NodeId,
        children: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
}

An inline element: participates in line layout.

Variants

Text

A run of text. The frontend has already decoded entities; the engine sees plain Unicode.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

value: String

The characters themselves, entities already decoded.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Break

A hard line break: the line ends here, and what follows stays in the same block. It holds no text.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Emphasis

*emphasis*: italic, in the default sheet.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

children: Vec<Inline>

The emphasised inlines.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Strong

**strong**: bold, in the default sheet.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

children: Vec<Inline>

The strengthened inlines.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Code

`code`: monospace, and never hyphenated.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

value: String

The literal code text; no markup inside.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Link

A hyperlink. The text lays out; the url is for painters that can express one.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

url: String

The link target.

children: Vec<Inline>

The linked inlines.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Note

A footnote. Its reference sits in the line where it was written, and its blocks are set at the foot of the page that reference lands on.

The blocks are the note itself, so a note holds paragraphs, lists and everything else a blockquote holds. The engine sets the reference and the number beside the note from the cascade, so neither is in the tree.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

blocks: Vec<Block>

The note itself, in reading order.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Strikethrough

~~struck~~: a line through it, in the default sheet.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

children: Vec<Inline>

The struck inlines.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Span

A run the sheet names, and nothing else. It carries no meaning of its own, so the built-in sheet styles it like the text around it and a class on it is what reaches it.

Fields

id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

children: Vec<Inline>

The inlines inside the run.

attributes: Attributes

What a sheet names it by.

position: Option<SourcePos>

Where the frontend read this from.

span: Option<SourceSpan>

The bytes of that source it was read from.

Trait Implementations

impl Clone for Inline

fn clone(&self) -> Inline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Inline

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Inline

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Inline

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Inline

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Inline