Crate lychee_lib

Expand description

lychee-lib is the library component of lychee, and is used for checking links.

“Hello world” example:

use lychee_lib::Result;

#[tokio::main]
async fn main() -> Result<()> {
  let response = lychee_lib::check("https://github.com/lycheeverse/lychee").await?;
  println!("{response}");
  Ok(())
}

For more specific use-cases you can build a lychee client yourself, using the ClientBuilder which can be used to configure and run your own link checker and grants full flexibility:

use lychee_lib::{ClientBuilder, Result, Status};

#[tokio::main]
async fn main() -> Result<()> {
  let client = ClientBuilder::default().client()?;
  let response = client.check("https://github.com/lycheeverse/lychee").await?;
  assert!(response.status().is_success());
  Ok(())
}

Modules

collector

A pool of clients, to handle concurrent checks

extract

Functionality to extract URIs from inputs

filter

Filters are a way to define behavior when encountering URIs that need to be treated differently, such as local IPs or e-mail addresses

remap

Remapping rules which allow to map URIs matching a pattern to a different URI. Use in moderation as there are no safety- or performance guarantees.

Structs

Client

Handles incoming requests and returns responses.

ClientBuilder

Builder for Client.

Collector

Collector keeps the state of link collection It drives the link extraction from inputs

Excludes

Exclude configuration for the link checker. You can ignore links based on regex patterns.

Filter

A generic URI filter Used to decide if a given URI should be checked or skipped

Includes

Include configuration for the link checker. You can include links based on regex patterns

Input

Lychee Input with optional file hint for parsing

InputContent

Encapsulates the content for a given input

Request

A request type that can be handle by lychee

Response

Response type returned by lychee after checking a URI

ResponseBody

Encapsulates the state of a URI check

Uri

Lychee’s own representation of a URI, which encapsulates all supported formats.

Enums

Base

When encountering links without a full domain in a document, the base determines where this resource can be found. Both, local and remote targets are supported.

CacheStatus

Representation of the status of a cached request. This is kept simple on purpose because the type gets serialized to a cache file and might need to be parsed by other tools or edited by humans.

ErrorKind

Kinds of status errors Note: The error messages can change over time, so don’t match on the output

FileType

FileType defines which file types lychee can handle

InputSource

Input types which lychee supports

Status

Response status of the request.