InlineMacro

Enum InlineMacro 

Source
#[non_exhaustive]
pub enum InlineMacro {
Show 14 variants Footnote(Footnote), Icon(Icon), Image(Box<Image>), Keyboard(Keyboard), Button(Button), Menu(Menu), Url(Url), Link(Link), Mailto(Mailto), Autolink(Autolink), CrossReference(CrossReference), Pass(Pass), Stem(Stem), IndexTerm(IndexTerm),
}
Expand description

An inline macro - a functional element that produces inline content.

Unlike a struct with name/target/attributes fields, InlineMacro is an enum where each variant represents a specific macro type with its own specialized fields.

§Variants Overview

VariantAsciiDoc SyntaxDescription
Linklink:url[text]Explicit link with optional text
Url\https://... or link:URL reference
Mailtomailto:addr[text]Email link
Autolink<\https://...>Auto-detected URL
CrossReference<<id>> or xref:id[]Internal document reference
Imageimage:file.png[alt]Inline image
Iconicon:name[]Icon reference (font or image)
Footnotefootnote:[text]Footnote reference
Keyboardkbd:[Ctrl+C]Keyboard shortcut
Buttonbtn:[OK]UI button label
Menumenu:File[Save]Menu navigation path
Passpass:[content]Passthrough (no processing)
Stemstem:[formula]Math notation
IndexTerm((term)) or (((term)))Index term (visible or hidden)

§Example

fn extract_link_target(node: &InlineNode) -> Option<String> {
    match node {
        InlineNode::Macro(InlineMacro::Link(link)) => Some(link.target.to_string()),
        InlineNode::Macro(InlineMacro::Url(url)) => Some(url.target.to_string()),
        InlineNode::Macro(InlineMacro::CrossReference(xref)) => Some(xref.target.clone()),
        _ => None,
    }
}

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

Footnote(Footnote)

Footnote reference: footnote:[content] or footnote:id[content]

§

Icon(Icon)

Icon macro: icon:name[attributes]

§

Image(Box<Image>)

Inline image: image:path[alt,width,height]

§

Keyboard(Keyboard)

Keyboard shortcut: kbd:[Ctrl+C]

§

Button(Button)

UI button: btn:[Label]

§

Menu(Menu)

Menu path: menu:TopLevel[Item > Subitem]

§

Url(Url)

URL with optional text: parsed from link: macro or bare URLs

Explicit link macro: link:target[text]

§

Mailto(Mailto)

Email link: mailto:address[text]

Auto-detected URL: <\https://example.com>

§

CrossReference(CrossReference)

Cross-reference: <<id,text>> or xref:id[text]

§

Pass(Pass)

Inline passthrough: pass:[content] - not serialized to ASG

§

Stem(Stem)

Inline math: stem:[formula] or latexmath:[...] / asciimath:[...]

§

IndexTerm(IndexTerm)

Index term: ((term)) (visible) or (((term))) (hidden)

Trait Implementations§

Source§

impl Clone for InlineMacro

Source§

fn clone(&self) -> InlineMacro

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 InlineMacro

Source§

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

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

impl PartialEq for InlineMacro

Source§

fn eq(&self, other: &InlineMacro) -> 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 Serialize for InlineMacro

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for InlineMacro

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more