Struct lychee_lib::Collector

pub struct Collector { /* private fields */ }

Collector keeps the state of link collection It drives the link extraction from inputs

Implementations

impl Collector

pub const fn new(base: Option<Base>) -> Self

Create a new collector with an empty cache

pub const fn skip_missing_inputs(self, yes: bool) -> Self

Skip missing input files (default is to error if they don’t exist)

pub const fn use_html5ever(self, yes: bool) -> Self

Use html5ever to parse HTML instead of html5gum.

pub const fn include_verbatim(self, yes: bool) -> Self

Skip over links in verbatim sections (like Markdown code blocks)

pub fn basic_auth_extractor(self, extractor: BasicAuthExtractor) -> Self

Pass a BasicAuthExtractor which is capable to match found URIs to basic auth credentials. These credentials get passed to the request in question.

pub fn collect_sources( self, inputs: Vec<Input> ) -> impl Stream<Item = Result<String>>

Collect all sources from a list of Inputs. For further details, see also Input::get_sources.

pub fn collect_links( self, inputs: Vec<Input> ) -> impl Stream<Item = Result<Request>>

Fetch all unique links from inputs All relative URLs get prefixed with base (if given). (This can be a directory or a base URL)

Errors

Will return Err if links cannot be extracted from an input

Trait Implementations

impl Clone for Collector

fn clone(&self) -> Collector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collector

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

Formats the value using the given formatter.