Struct linkify::LinkFinder

pub struct LinkFinder { /* fields omitted */ }

A configured link finder.

Methods

impl LinkFinder

pub fn new() -> LinkFinder

Create a new link finder with the default options for finding all kinds of links.

If you only want to find a certain kind of links, use the kinds method.

pub fn email_domain_must_have_dot(&mut self, value: bool) -> &mut LinkFinder

Require the domain parts of email addresses to have at least one dot. Use false to also find addresses such as root@localhost.

pub fn kinds(&mut self, kinds: &[LinkKind]) -> &mut LinkFinder

Restrict the kinds of links that should be found to the specified ones.

Important traits for Links<'t>

impl<'t> Iterator for Links<'t> type Item = Link<'t>;

pub fn links<'t>(&self, text: &'t str) -> Links<'t>

Find links in the specified input text.

Returns an Iterator which only scans when next is called (lazy).

Important traits for Spans<'t>

impl<'t> Iterator for Spans<'t> type Item = Span<'t>;

pub fn spans<'t>(&self, text: &'t str) -> Spans<'t>

Iterate over spans in the specified input text.

A span represents a substring of the input text, which can either be a link, or plain text.

Returns an Iterator which only scans when next is called (lazy).

The spans that are returned by the Iterator are consecutive, and when combined represent the input text in its entirety.

Trait Implementations

impl Default for LinkFinder

fn default() -> Self

Returns the "default value" for a type.

impl Debug for LinkFinder

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

Formats the value using the given formatter.