Struct lychee_lib::Client

pub struct Client { /* private fields */ }

Handles incoming requests and returns responses.

See ClientBuilder which contains sane defaults for all configuration options.

Implementations

impl Client

pub async fn check<T, E>(&self, request: T) -> Result<Response>

where Request: TryFrom<T, Error = E>, ErrorKind: From<E>,

Check a single request.

request can be either a Request or a type that can be converted into it. In any case, it must represent a valid URI.

Errors

Returns an Err if:

• request does not represent a valid URI.
• Encrypted connection for a HTTP URL is available but unused. (Only checked when Client::require_https is true.)

pub fn remap(&self, uri: &mut Uri) -> Result<()>

Remap uri using the client-defined remapping rules.

Errors

Returns an Err if the final, remapped uri is not a valid URI.

pub fn is_excluded(&self, uri: &Uri) -> bool

Returns whether the given uri should be ignored from checking.

pub async fn check_website( &self, uri: &Uri, credentials: &Option<BasicAuthCredentials> ) -> Result<Status>

Checks the given URI of a website.

Errors

This returns an Err if

• The URI is invalid.
• The request failed.
• The response status code is not accepted.
• The URI cannot be converted to HTTPS.

pub async fn check_website_inner( &self, uri: &Uri, credentials: &Option<BasicAuthCredentials> ) -> Status

Checks the given URI of a website.

Unsupported schemes will be ignored

Errors

This returns an Err if

• The URI is invalid.
• The request failed.
• The response status code is not accepted.

pub async fn check_file(&self, uri: &Uri) -> Status

Check a file URI.

pub async fn check_fragment(&self, path: &Path, uri: &Uri) -> Status

Checks a file URI’s fragment.

pub async fn check_mail(&self, uri: &Uri) -> Status

Check a mail address, or equivalently a mailto URI.

URIs may contain query parameters (e.g. contact@example.com?subject="Hello"), which are ignored by this check. The are not part of the mail address and instead passed to a mail client.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.