lychee-lib 0.24.1

A fast, async link checker
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use std::{borrow::Cow, convert::TryFrom, fmt::Display};

use crate::{BasicAuthCredentials, ErrorKind, Uri, types::uri::raw::RawUriSpan};

use super::ResolvedInputSource;

/// A checkable element extracted from a [`ResolvedInputSource`],
/// containing a [`Uri`] and additional metadata associated with it.
#[derive(Debug, PartialEq, Eq, Hash, Clone)]
pub struct Request {
    /// The extracted Uniform Resource Identifier
    /// which can be checked with lychee
    pub uri: Uri,

    /// The resource which contains the given URI
    pub source: ResolvedInputSource,

    /// How the URI is rendered inside a document
    /// (for example `img`, `a`, `pre`, or `code`).
    /// In case of plaintext input the field is `None`.
    pub element: Option<String>,

    /// What attribute (e.g. `href`) the URI is contained in
    pub attribute: Option<String>,

    /// Where the URI is located
    pub span: Option<RawUriSpan>,

    /// Basic auth credentials
    pub credentials: Option<BasicAuthCredentials>,
}

impl Request {
    /// Instantiate a new `Request` object,
    /// with optional fields set to `None`
    #[inline]
    #[must_use]
    pub const fn new(uri: Uri, source: ResolvedInputSource) -> Self {
        Request {
            uri,
            source,
            element: None,
            attribute: None,
            span: None,
            credentials: None,
        }
    }

    /// Set [`Self::element`]
    #[must_use]
    pub fn with_element(mut self, element: String) -> Self {
        self.element = Some(element);
        self
    }

    /// Set [`Self::attribute`]
    #[must_use]
    pub fn with_attribute(mut self, attribute: String) -> Self {
        self.attribute = Some(attribute);
        self
    }

    /// Set [`Self::span`]
    #[must_use]
    pub const fn with_span(mut self, span: RawUriSpan) -> Self {
        self.span = Some(span);
        self
    }

    /// Set [`Self::credentials`]
    #[must_use]
    pub fn with_credentials(mut self, credentials: BasicAuthCredentials) -> Self {
        self.credentials = Some(credentials);
        self
    }
}

impl Display for Request {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} ({})", self.uri, self.source)
    }
}

impl TryFrom<Uri> for Request {
    type Error = ErrorKind;

    fn try_from(uri: Uri) -> Result<Self, Self::Error> {
        Ok(Request::new(
            uri.clone(),
            ResolvedInputSource::RemoteUrl(Box::new(uri.url)),
        ))
    }
}

impl TryFrom<String> for Request {
    type Error = ErrorKind;

    fn try_from(s: String) -> Result<Self, Self::Error> {
        let uri = Uri::try_from(s.as_str())?;
        Ok(Request::new(
            uri,
            ResolvedInputSource::String(Cow::Owned(s)),
        ))
    }
}

impl TryFrom<&str> for Request {
    type Error = ErrorKind;

    fn try_from(s: &str) -> Result<Self, Self::Error> {
        let uri = Uri::try_from(s)?;
        Ok(Request::new(
            uri,
            ResolvedInputSource::String(Cow::Owned(s.to_owned())),
        ))
    }
}