Skip to main content

Mark

Enum Mark 

Source
pub enum Mark {
    Bold,
    Italic,
    Underline,
    Strikethrough,
    Code,
    Superscript,
    Subscript,
    Link {
        href: String,
        title: Option<String>,
    },
    Anchor {
        id: String,
    },
    Footnote {
        number: u32,
        id: Option<String>,
    },
    Math {
        format: MathFormat,
        source: String,
    },
    Extension(ExtensionMark),
}
Expand description

Formatting marks that can be applied to text.

Marks represent inline formatting such as bold, italic, links, etc. Multiple marks can be applied to the same text node.

§Serialization

Simple marks (Bold, Italic, etc.) serialize as plain strings: "bold". Complex marks (Link, Math, etc.) serialize as objects with a "type" field. Extension marks serialize with their namespaced type as "type".

Variants§

§

Bold

Bold/strong text.

§

Italic

Italic/emphasized text.

§

Underline

Underlined text.

§

Strikethrough

Strikethrough text.

§

Code

Inline code (monospace).

§

Superscript

Superscript text.

§

Subscript

Subscript text.

Hyperlink.

Fields

§href: String

Link destination URL.

§title: Option<String>

Optional link title.

§

Anchor

Named anchor mark for creating anchor points in text.

Fields

§id: String

Unique identifier for this anchor.

§

Footnote

Footnote reference mark (semantic extension).

Links text to a footnote block elsewhere in the document.

Fields

§number: u32

Sequential footnote number.

§id: Option<String>

Optional unique identifier for cross-referencing.

§

Math

Inline mathematical expression.

Fields

§format: MathFormat

Math format (latex or mathml).

§source: String

The mathematical expression source.

§

Extension(ExtensionMark)

Extension mark for custom/unknown mark types.

Extension marks use namespaced types like “semantic:citation” or “legal:cite”. This enables extensions to add custom inline marks without modifying the core Mark enum.

Implementations§

Source§

impl Mark

Source

pub fn mark_type(&self) -> MarkType

Get the type of this mark.

Source

pub fn is_extension(&self) -> bool

Check if this mark is an extension mark.

Source

pub fn as_extension(&self) -> Option<&ExtensionMark>

Get the extension mark if this is one.

Trait Implementations§

Source§

impl Clone for Mark

Source§

fn clone(&self) -> Mark

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 Mark

Source§

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

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

impl<'de> Deserialize<'de> for Mark

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Mark

Source§

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

Source§

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

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

impl Eq for Mark

Source§

impl StructuralPartialEq for Mark

Auto Trait Implementations§

§

impl Freeze for Mark

§

impl RefUnwindSafe for Mark

§

impl Send for Mark

§

impl Sync for Mark

§

impl Unpin for Mark

§

impl UnsafeUnpin for Mark

§

impl UnwindSafe for Mark

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Checks if this value is equivalent to the given key. Read more
Source§

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

Source§

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

Compare self to key and return true if they are equal.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
Source§

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