Struct lychee_lib::extract::Extractor

pub struct Extractor { /* private fields */ }

A handler for extracting links from various input formats like Markdown and HTML. Allocations should be avoided if possible as this is a performance-critical section of the library.

Implementations

impl Extractor

pub const fn new(use_html5ever: bool, include_verbatim: bool) -> Self

Creates a new extractor

The extractor can be configured with the following settings:

• use_html5ever enables the alternative HTML parser engine html5ever, that is also used in the Servo browser by Mozilla. The default is html5gum, which is more performant and well maintained.

• include_verbatim ignores links inside Markdown code blocks. These can be denoted as a block starting with three backticks or an indented block. For more information, consult the pulldown_cmark documentation about code blocks here

pub fn extract(&self, input_content: &InputContent) -> Vec<RawUri>

Main entrypoint for extracting links from various sources (Markdown, HTML, and plaintext)

Trait Implementations

impl Clone for Extractor

fn clone(&self) -> Extractor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Extractor

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

Formats the value using the given formatter.

impl Default for Extractor

fn default() -> Extractor

Returns the “default value” for a type.

impl Copy for Extractor