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

Errors

This returns an Err if

• request is invalid.
• The URI of the request is invalid.
• Encrypted connection for a HTTP URL is available but unused. (Only checked when Client::require_https is true.)

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

Remap URI using the client-defined remap patterns

Errors

Returns an error if the remapping value is not a 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) -> Status

Checks the given URI of a website.

Unsupported schemes will be ignored

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

Check a file URI.

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

Check a mail address, or equivalently a mailto URI.

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.