Struct mdbook_linkcheck::ValidationOutcome

pub struct ValidationOutcome {
    pub valid_links: Vec<Link>,
    pub invalid_links: Vec<InvalidLink>,
    pub ignored: Vec<Link>,
    pub unknown_category: Vec<Link>,
    pub incomplete_links: Vec<IncompleteLink>,
}

The outcome of validating a set of links.

Fields

valid_links: Vec<Link>

Valid links.

invalid_links: Vec<InvalidLink>

Links where validation failed.

ignored: Vec<Link>

Links which have been ignored (e.g. due to Config::follow_web_links).

unknown_category: Vec<Link>

Links which we don’t know how to handle.

incomplete_links: Vec<IncompleteLink>

Potentially incomplete links.

Implementations

impl ValidationOutcome

pub fn generate_diagnostics(
    &self,
    files: &Files<String>,
    warning_policy: WarningPolicy
) -> Vec<Diagnostic<FileId>>

Generate a list of Diagnostic messages from this ValidationOutcome.

Trait Implementations

impl Debug for ValidationOutcome

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

Formats the value using the given formatter.

impl Default for ValidationOutcome

fn default() -> ValidationOutcome

Returns the “default value” for a type.