Enum Status 

pub enum Status {
    Ok(StatusCode),
    Error(ErrorKind),
    Timeout(Option<StatusCode>),
    Redirected(StatusCode),
    UnknownStatusCode(StatusCode),
    Excluded,
    Unsupported(ErrorKind),
    Cached(CacheStatus),
}

Response status of the request.

Variants

Ok(StatusCode)

Request was successful

Error(ErrorKind)

Failed request

Timeout(Option<StatusCode>)

Request timed out

Redirected(StatusCode)

Got redirected to different resource

UnknownStatusCode(StatusCode)

The given status code is not known by lychee

Excluded

Resource was excluded from checking

Unsupported(ErrorKind)

The request type is currently not supported, for example when the URL scheme is slack://. See https://github.com/lycheeverse/lychee/issues/199

Cached(CacheStatus)

Cached request status from previous run

Implementations

impl Status

pub fn new(response: &Response, accepted: &HashSet<StatusCode>) -> Self

Create a status object from a response and the set of accepted status codes

pub fn from_cache_status(s: CacheStatus, accepted: &HashSet<u16>) -> Self

Create a status object from a cached status (from a previous run of lychee) and the set of accepted status codes.

The set of accepted status codes can change between runs, necessitating more complex logic than just using the cached status.

Note that the accepted status codes are not of type StatusCode, because they are provided by the user and can be invalid according to the HTTP spec and IANA, but the user might still want to accept them.

pub fn details(&self) -> Option<String>

Return more details about the status (if any)

Which additional information we can extract depends on the underlying request type. The output is purely meant for humans and future changes are expected.

It is modeled after reqwest’s details method.

pub const fn is_success(&self) -> bool

Returns true if the check was successful

pub const fn is_error(&self) -> bool

Returns true if the check was not successful

pub const fn is_excluded(&self) -> bool

Returns true if the check was excluded

pub const fn is_timeout(&self) -> bool

Returns true if a check took too long to complete

pub const fn is_unsupported(&self) -> bool

Returns true if a URI is unsupported

pub const fn icon(&self) -> &str

Return a unicode icon to visualize the status

pub fn code(&self) -> Option<StatusCode>

Return the HTTP status code (if any)

pub fn code_as_string(&self) -> String

Return the HTTP status code as string (if any)

pub const fn is_unknown(&self) -> bool

Returns true if the status code is unknown (i.e. not a valid HTTP status code)

For example, 200 is a valid HTTP status code, while 999 is not.

Trait Implementations

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.

impl From<&Status> for CacheStatus

fn from(s: &Status) -> Self

Converts to this type from the input type.

impl From<Error> for Status

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for Status

fn from(e: ErrorKind) -> Self

Converts to this type from the input type.

impl Hash for Status

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 Status

fn eq(&self, other: &Status) -> 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 Serialize for Status

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Status

impl StructuralPartialEq for Status