Struct Request 

pub struct Request {
    pub uri: Uri,
    pub source: ResolvedInputSource,
    pub element: Option<String>,
    pub attribute: Option<String>,
    pub span: Option<RawUriSpan>,
    pub credentials: Option<BasicAuthCredentials>,
}

A checkable element extracted from a ResolvedInputSource, containing a Uri and additional metadata associated with it.

Fields

uri: Uri

The extracted Uniform Resource Identifier which can be checked with lychee

source: ResolvedInputSource

The resource which contains the given URI

element: Option<String>

How the URI is rendered inside a document (for example img, a, pre, or code). In case of plaintext input the field is None.

attribute: Option<String>

What attribute (e.g. href) the URI is contained in

span: Option<RawUriSpan>

Where the URI is located

credentials: Option<BasicAuthCredentials>

Basic auth credentials

Implementations

impl Request

pub const fn new(uri: Uri, source: ResolvedInputSource) -> Self

Instantiate a new Request object, with optional fields set to None

pub fn with_element(self, element: String) -> Self

Set Self::element

pub fn with_attribute(self, attribute: String) -> Self

Set Self::attribute

pub const fn with_span(self, span: RawUriSpan) -> Self

Set Self::span

pub fn with_credentials(self, credentials: BasicAuthCredentials) -> Self

Set Self::credentials

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Display for Request

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

Formats the value using the given formatter.

impl Hash for Request

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Request

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for Request

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Request

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Uri> for Request

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(uri: Uri) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Request

impl StructuralPartialEq for Request