Struct mdbook_linkcheck::ValidationOutcome

source · [−]

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>,
}

Expand description

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

source

impl ValidationOutcome

source

pub fn generate_diagnostics(
 &self,
 files: &Files<String>,
 warning_policy: WarningPolicy
) -> Vec<Diagnostic<FileId>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Generate a list of Diagnostic messages from this ValidationOutcome.

Trait Implementations

source

impl Debug for ValidationOutcome

source

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

Formats the value using the given formatter. Read more

source

impl Default for ValidationOutcome

source

fn default() -> ValidationOutcome

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for ValidationOutcome

impl Send for ValidationOutcome

impl Sync for ValidationOutcome

impl Unpin for ValidationOutcome

impl !UnwindSafe for ValidationOutcome

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct mdbook_linkcheck::ValidationOutcome

Fields

Implementations

impl ValidationOutcome

pub fn generate_diagnostics(
    &self,
    files: &Files<String>,
    warning_policy: WarningPolicy
) -> Vec<Diagnostic<FileId>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where     A: Allocator,`

Trait Implementations

impl Debug for ValidationOutcome

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

impl Default for ValidationOutcome

fn default() -> ValidationOutcome

Auto Trait Implementations

impl !RefUnwindSafe for ValidationOutcome

impl Send for ValidationOutcome

impl Sync for ValidationOutcome

impl Unpin for ValidationOutcome

impl !UnwindSafe for ValidationOutcome

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct mdbook_linkcheck::ValidationOutcome

Fields

Implementations

impl ValidationOutcome

pub fn generate_diagnostics( &self, files: &Files<String>, warning_policy: WarningPolicy) -> Vec<Diagnostic<FileId>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

Trait Implementations

impl Debug for ValidationOutcome

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

impl Default for ValidationOutcome

fn default() -> ValidationOutcome

Auto Trait Implementations

impl !RefUnwindSafe for ValidationOutcome

impl Send for ValidationOutcome

impl Sync for ValidationOutcome

impl Unpin for ValidationOutcome

impl !UnwindSafe for ValidationOutcome

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn generate_diagnostics(
&self,
files: &Files<String>,
warning_policy: WarningPolicy
) -> Vec<Diagnostic<FileId>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,