Skip to main content

Linkifier

Struct Linkifier 

Source
pub struct Linkifier { /* private fields */ }
Expand description

A link detector over one scheme list.

Implementations§

Source§

impl Linkifier

Source

pub fn new<S: AsRef<str>>(schemes: impl IntoIterator<Item = S>) -> Linkifier

A detector for exactly these scheme prefixes ("https://", "mailto:"). Matching is case-insensitive; empty entries are ignored, and so is an entry without a :, which could never be a scheme.

Source

pub fn schemes(&self) -> &[String]

The scheme prefixes this detector links.

Source

pub fn allows(&self, href: &str) -> bool

Whether href starts with one of the schemes. What a markdown [label](url) is checked against: anything else — javascript:, data:, file: — renders as the literal text that was typed.

Source

pub fn has_scheme(&self, word: &str) -> bool

Whether a word starts with a scheme or a bare www.-style prefix.

Source

pub fn is_url(&self, word: &str) -> bool

Whether a whitespace-delimited word is a link: a URL, or a bare email address.

Source

pub fn normalize(&self, word: &str) -> String

The form of word a launcher can open: a scheme is prepended to bare www. hosts and email addresses, and anything already carrying one comes back unchanged.

Source

pub fn scan(&self, text: &str) -> Vec<Range<usize>>

Every link in text, as byte ranges on character boundaries.

A link starts at the beginning of the text or after whitespace or an opening delimiter, and runs to whitespace or a closing one. Trailing sentence punctuation is dropped, and so is a closing paren or bracket — unless the URL opened one itself, which is the shape of a Wikipedia link. Bare email addresses are links too, which Linkifier::normalize turns into mailto:.

Trait Implementations§

Source§

impl Clone for Linkifier

Source§

fn clone(&self) -> Self

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§

impl Debug for Linkifier

Source§

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

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

impl Default for Linkifier

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Linkifier

Source§

impl PartialEq for Linkifier

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Linkifier

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<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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.