Struct Hyperlinker 

pub struct Hyperlinker { /* private fields */ }

Recognises linkable spans in text and builds their URLs.

Implementations

impl Hyperlinker

pub fn new() -> Self

Link URLs and paths; references need repository.

pub fn disabled() -> Self

A linker that links nothing (the plain fallback, chosen explicitly).

pub fn enabled(self, enabled: bool) -> Self

Turn linking on or off.

pub fn is_enabled(&self) -> bool

Whether this linker adds links at all.

pub fn urls(self, urls: bool) -> Self

Link http(s):// URLs (default on).

pub fn paths(self, paths: bool) -> Self

Link file paths and path:line:column locations (default on).

pub fn base_dir(self, dir: impl Into<PathBuf>) -> Self

Resolve relative paths against dir.

pub fn editor(self, template: impl Into<String>) -> Self

Link files through an editor URL template instead of file://, for example vscode://file{path}:{line}:{column}. {path} is absolute and already starts with /, so the template has no slash of its own before it. {line} and {column} default to 1 when a location has none.

pub fn repository(self, url: impl Into<String>) -> Self

The repository web URL (https://github.com/owner/repo) that #123 references link into. owner/repo#123 links into that repository on the same host.

pub fn file_url( &self, path: &str, line: Option<usize>, column: Option<usize>, ) -> Option<String>

The URL for a file location, or None when linking is off.

pub fn reference_url(&self, repo: Option<&str>, number: u64) -> Option<String>

The URL for issue or pull request number, in repo (owner/name) or the configured repository.

pub fn find(&self, text: &str) -> Vec<Link>

Everything linkable in text, in order, without overlaps: URLs first, then references, then paths outside those.

pub fn link(&self, text: &mut Text)

Add a link span for everything find recognises.

pub fn location( &self, path: &str, line: Option<usize>, column: Option<usize>, style: impl Into<StyleType>, ) -> Text

path:line:column as text linked to the location, in style.

Trait Implementations

impl Clone for Hyperlinker

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hyperlinker

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

Formats the value using the given formatter.

impl Default for Hyperlinker

fn default() -> Self

Returns the “default value” for a type.

impl Highlighter for Hyperlinker

fn highlight(&self, text: &mut Text)

Inspect text and apply any style spans in place.

impl LinkProvider for Hyperlinker

Local file:// or editor links through a Hyperlinker.

fn file_url(&self, path: &str) -> Option<String>

The URL for a file.

fn line_url(&self, path: &str, line: usize) -> Option<String>

The URL for a line of a file’s new version.