[−][src]Struct mdbook_linkcheck::Config
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<Regex>
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.
Methods
impl Config
[src]
pub const DEFAULT_CACHE_TIMEOUT: Duration
[src]
The default cache timeout (around 12 hours).
pub const DEFAULT_USER_AGENT: &'static str
[src]
The default user-agent.
pub fn should_skip(&self, link: &str) -> bool
[src]
Checks Config::exclude
to see if the provided link should be
skipped.
Trait Implementations
impl Clone for Config
[src]
impl Default for Config
[src]
impl PartialEq<Config> for Config
[src]
impl Debug for Config
[src]
impl Serialize for Config
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for Config where
Config: Default,
[src]
Config: Default,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
impl !RefUnwindSafe for Config
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,