Struct HyperlinkAlias 

pub struct HyperlinkAlias { /* private fields */ }

An alias for a hyperlink format.

Hyperlink aliases are built-in formats, therefore they hold static values. Some of their features are usable in const blocks.

Implementations

impl HyperlinkAlias

pub const fn name(&self) -> &str

Returns the name of the alias.

pub const fn description(&self) -> &str

Returns a very short description of this hyperlink alias.

pub const fn display_priority(&self) -> Option<i16>

Returns the display priority of this alias.

If no priority is set, then None is returned.

The display priority is meant to reflect some special status associated with an alias. For example, the default and none aliases have a display priority. This is meant to encourage listing them first in documentation.

A lower display priority implies the alias should be shown before aliases with a higher (or absent) display priority.

Callers cannot rely on any specific display priority value to remain stable across semver compatible releases of this crate.

Trait Implementations

impl Clone for HyperlinkAlias

fn clone(&self) -> HyperlinkAlias

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperlinkAlias

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

Formats the value using the given formatter.