Struct Collector 

pub struct Collector { /* private fields */ }

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

Implementations

impl Collector

pub fn new(root_dir: Option<PathBuf>, base: Option<Base>) -> Result<Self>

Create a new collector with an empty cache

Errors

Returns an Err if the root_dir is not an absolute path or if the reqwest Client fails to build

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 skip_hidden(self, yes: bool) -> Self

Skip files that are hidden

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

Skip files that are ignored

pub fn headers(self, headers: HeaderMap) -> Self

Set headers to use when resolving input URLs

pub fn client(self, client: Client) -> Self

Set client to use for checking input URLs

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 const fn include_wikilinks(self, yes: bool) -> Self

Check WikiLinks in Markdown files

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 excluded_paths(self, excluded_paths: PathExcludes) -> Self

Configure which paths to exclude

pub fn collect_sources( self, inputs: HashSet<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_sources_with_file_types( self, inputs: HashSet<Input>, file_extensions: FileExtensions, ) -> impl Stream<Item = Result<String>> + 'static

Collect all sources from a list of Inputs with specific file extensions.

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

Convenience method to fetch all unique links from inputs with the default extensions.

pub fn collect_links_from_file_types( self, inputs: HashSet<Input>, extensions: FileExtensions, ) -> 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 duplicate 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.

impl Default for Collector

fn default() -> Self

Panics

We call Client::new() which can panic in certain scenarios. Use Collector::new() to handle ClientBuilder errors gracefully.