Skip to main content

ExtensionMark

Struct ExtensionMark 

Source
pub struct ExtensionMark {
    pub namespace: String,
    pub mark_type: String,
    pub attributes: Value,
}
Expand description

An extension mark for unsupported or unknown mark types.

When parsing a document with extension marks (e.g., “semantic:citation”), this struct preserves the raw data so it can be:

  • Passed through unchanged when saving
  • Processed by extension-aware applications

Fields§

§namespace: String

The extension namespace (e.g., “semantic”, “legal”, “presentation”).

§mark_type: String

The mark type within the namespace (e.g., “citation”, “entity”, “index”).

§attributes: Value

Extension-specific attributes.

Implementations§

Source§

impl ExtensionMark

Source

pub fn new(namespace: impl Into<String>, mark_type: impl Into<String>) -> Self

Create a new extension mark.

Source

pub fn parse_type(type_str: &str) -> Option<(&str, &str)>

Parse an extension type string like “semantic:citation” into (namespace, mark_type).

Returns None if the type doesn’t contain a colon.

Source

pub fn full_type(&self) -> String

Get the full type string (e.g., “semantic:citation”).

Source

pub fn is_namespace(&self, namespace: &str) -> bool

Check if this extension is from a specific namespace.

Source

pub fn is_type(&self, namespace: &str, mark_type: &str) -> bool

Check if this is a specific extension type.

Source

pub fn with_attributes(self, attributes: Value) -> Self

Set the attributes.

Source

pub fn get_attribute(&self, key: &str) -> Option<&Value>

Get an attribute value by key.

Source

pub fn get_string_attribute(&self, key: &str) -> Option<&str>

Get a string attribute.

Source

pub fn get_string_array_attribute(&self, key: &str) -> Option<Vec<&str>>

Get an array-of-strings attribute.

Source

pub fn get_citation_refs(&self) -> Option<Vec<&str>>

Get citation refs, supporting both "refs" (array) and legacy "ref" (string).

Returns None if neither key is present.

Source

pub fn normalize_citation_attrs(&mut self)

Rewrite legacy "ref" (string) → "refs" (array) in the attributes map.

No-op if "refs" already exists or "ref" is absent.

Source

pub fn get_glossary_ref(&self) -> Option<&str>

Get glossary term ref, supporting both "ref" and legacy "termId".

Returns None if neither key is present.

Source

pub fn normalize_glossary_attrs(&mut self)

Rewrite legacy "termId""ref" in the attributes map.

No-op if "ref" already exists or "termId" is absent.

Source

pub fn citation(reference: impl Into<String>) -> Self

Create a citation mark (semantic extension).

Source

pub fn citation_with_page( reference: impl Into<String>, page: impl Into<String>, ) -> Self

Create a citation mark with page locator.

Source

pub fn multi_citation(refs: &[String]) -> Self

Create a multi-reference citation mark (e.g., [smith2023; jones2024]).

Source

pub fn entity(uri: impl Into<String>, entity_type: impl Into<String>) -> Self

Create an entity link mark (semantic extension).

Source

pub fn glossary(term_id: impl Into<String>) -> Self

Create a glossary reference mark (semantic extension).

Source

pub fn index(term: impl Into<String>) -> Self

Create an index mark (presentation extension).

Source

pub fn index_with_subterm( term: impl Into<String>, subterm: impl Into<String>, ) -> Self

Create an index mark with subterm.

Source

pub fn equation_ref(target: impl Into<String>) -> Self

Create an equation reference mark (academic extension).

References an equation by its ID (e.g., “#eq-pythagoras”).

Source

pub fn equation_ref_formatted( target: impl Into<String>, format: impl Into<String>, ) -> Self

Create an equation reference mark with custom format.

The format string can use {number} as a placeholder for the equation number.

Source

pub fn algorithm_ref(target: impl Into<String>) -> Self

Create an algorithm reference mark (academic extension).

References an algorithm by its ID (e.g., “#alg-quicksort”).

Source

pub fn algorithm_ref_line( target: impl Into<String>, line: impl Into<String>, ) -> Self

Create an algorithm reference mark with line reference.

References a specific line within an algorithm.

Source

pub fn algorithm_ref_formatted( target: impl Into<String>, format: impl Into<String>, ) -> Self

Create an algorithm reference mark with custom format.

The format string can use {number} and {line} as placeholders.

Source

pub fn algorithm_ref_line_formatted( target: impl Into<String>, line: impl Into<String>, format: impl Into<String>, ) -> Self

Create an algorithm reference mark with line and custom format.

Source

pub fn theorem_ref(target: impl Into<String>) -> Self

Create a theorem reference mark (academic extension).

References a theorem by its ID (e.g., “#thm-pythagoras”).

Source

pub fn theorem_ref_formatted( target: impl Into<String>, format: impl Into<String>, ) -> Self

Create a theorem reference mark with custom format.

The format string can use {number} and {variant} as placeholders.

Source

pub fn highlight(color: impl Into<String>) -> Self

Create a highlight mark (collaboration extension).

Applies a colored highlight to text for collaborative annotation. Default color is yellow if not specified.

Source

pub fn highlight_yellow() -> Self

Create a highlight mark with default yellow color.

Source

pub fn highlight_colored(color: impl Display) -> Self

Create a highlight mark with a specific color.

Convenience method that accepts the HighlightColor display string.

Trait Implementations§

Source§

impl Clone for ExtensionMark

Source§

fn clone(&self) -> ExtensionMark

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 ExtensionMark

Source§

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

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

impl<'de> Deserialize<'de> for ExtensionMark

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

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

impl PartialEq for ExtensionMark

Source§

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

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 Eq for ExtensionMark

Source§

impl StructuralPartialEq for ExtensionMark

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<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>,