Skip to main content

Hyperlink

Enum Hyperlink 

Source
pub enum Hyperlink {
    External(String),
    Internal(String),
}
Expand description

A hyperlink attached to a run (w:hyperlink, CT_Hyperlink): either a link to an external URL, or a link to a bookmark elsewhere in the same document.

Strictly, in the underlying XML, a hyperlink is not a run property: <w:hyperlink> wraps its own nested run(s) (CT_Hyperlink’s content is EG_PContent, the very same group w:p itself uses), making it a sibling of <w:r> in a paragraph’s content, much like Field’s <w:fldSimple>. It is modeled here as a property on Run instead (alongside style_id, bold..) for a simpler, more consistent public API — the run’s own text/formatting still apply normally, the hyperlink just adds link behavior on top. When several consecutive runs each set a hyperlink, every one of them is written as its own separate <w:hyperlink> (and, for an external link, its own OPC relationship, even when two runs happen to share the same URL) rather than merged into a single wrapper — simpler and safer than trying to detect and dedupe repeated URLs across runs.

Variants§

§

External(String)

A link to an external URL (r:id, an OPC relationship with TargetMode="External" — the target is never resolved or validated as a package part, unlike an image’s r:embed).

§

Internal(String)

A link to a bookmark elsewhere in the same document (w:anchor), with no relationship at all. The anchor name is meant to match a Bookmark::name set via Run.bookmarks somewhere in the document, but this is not validated when writing — an Internal hyperlink to a name that isn’t actually bookmarked anywhere still produces a well-formed .docx, just a dead link in Word.

Trait Implementations§

Source§

fn clone(&self) -> Hyperlink

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§

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

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

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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