Struct linkcheck::validation::Options

pub struct Options { /* fields omitted */ }

Options to be used with resolve_link().

Implementations

impl Options

pub const DEFAULT_FILE: &'static str

The name used by Options::default_file().

pub fn default_alternate_extensions(
) -> impl IntoIterator<Item = (OsString, impl IntoIterator<Item = OsString>)>

A mapping of possible alternate extensions to try when checking a filesystem link.

pub fn new() -> Self

Create a new Options populated with some sane defaults.

pub fn root_directory(&self) -> Option<&Path>

Get the root directory, if one was provided.

pub fn with_root_directory<P: AsRef<Path>>(
    self,
    root_directory: P
) -> Result<Self>

Set the Options::root_directory(), automatically converting to its canonical form with dunce::canonicalize().

pub fn default_file(&self) -> &OsStr

The default file name to use when a directory is linked to.

pub fn set_default_file<O: Into<OsString>>(self, default_file: O) -> Self

Set the Options::default_file().

pub fn alternate_extensions(
    &self
) -> impl Iterator<Item = (&OsStr, impl Iterator<Item = &OsStr>)>

Get the map of alternate extensions to use when checking.

By default we only map *.md to *.html (Options::default_alternate_extensions()).

pub fn set_alternate_extensions<S, I, V>(self, alternates: I) -> Self where
    I: IntoIterator<Item = (S, V)>,
    S: Into<OsString>,
    V: IntoIterator<Item = S>, 

Set the Options::alternate_extensions() mapping.

pub fn links_may_traverse_the_root_directory(&self) -> bool

Are links allowed to go outside of the Options::root_directory()?

pub fn set_links_may_traverse_the_root_directory(self, value: bool) -> Self

Set Options::links_may_traverse_the_root_directory().

pub fn set_custom_validation<F>(self, custom_validation: F) -> Self where
    F: Fn(&Path, Option<&str>) -> Result<(), Reason> + 'static, 

Set a function which will be executed after a link is resolved, allowing you to apply custom business logic.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Options where
    Options: Default, 

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Options> for Options

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Options

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

Serialize this value into the given Serde serializer.