hyperlink_aliases

Function hyperlink_aliases 

Source
pub fn hyperlink_aliases() -> Vec<HyperlinkAlias>
Expand description

Returns the set of hyperlink aliases supported by this crate.

Aliases are supported by the FromStr trait implementation of a HyperlinkFormat. That is, if an alias is seen, then it is automatically replaced with the corresponding format. For example, the vscode alias maps to vscode://file{path}:{line}:{column}.

This is exposed to allow callers to include hyperlink aliases in documentation in a way that is guaranteed to match what is actually supported.

The list returned is guaranteed to be sorted lexicographically by the alias name. Callers may want to re-sort the list using HyperlinkAlias::display_priority via a stable sort when showing the list to users. This will cause special aliases like none and default to appear first.