Struct mdbook_linkcheck::Config

pub struct Config {
    pub follow_web_links: bool,
    pub traverse_parent_directories: bool,
    pub exclude: Vec<HashedRegex>,
    pub user_agent: String,
    pub cache_timeout: u64,
    pub warning_policy: WarningPolicy,
    pub http_headers: HashMap<HashedRegex, Vec<HttpHeader>>,
}

The configuration options available with this backend.

Fields

follow_web_links: bool

If a link on the internet is encountered, should we still try to check if it’s valid? Defaults to false because this has a big performance impact.

traverse_parent_directories: bool

Are we allowed to link to files outside of the book’s source directory?

exclude: Vec<HashedRegex>

A list of URL patterns to ignore when checking remote links.

user_agent: String

The user-agent used whenever any web requests are made.

cache_timeout: u64

The number of seconds a cached result is valid for.

warning_policy: WarningPolicy

The policy to use when warnings are encountered.

http_headers: HashMap<HashedRegex, Vec<HttpHeader>>

The map of regexes representing sets of web sites and the list of HTTP headers that must be sent to matching sites.

Implementations

impl Config

pub const DEFAULT_CACHE_TIMEOUT: Duration = _

The default cache timeout (around 12 hours).

pub const DEFAULT_USER_AGENT: &'static str = _

The default user-agent.

pub fn should_skip(&self, link: &str) -> bool

Checks Config::exclude to see if the provided link should be skipped.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Configwhere
    Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config