Struct lychee_lib::filter::Filter

pub struct Filter {
    pub includes: Option<Includes>,
    pub excludes: Option<Excludes>,
    pub schemes: HashSet<String>,
    pub exclude_private_ips: bool,
    pub exclude_link_local_ips: bool,
    pub exclude_loopback_ips: bool,
    pub exclude_mail: bool,
}

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

Fields

includes: Option<Includes>

URIs explicitly included for checking. This takes precedence over excludes

excludes: Option<Excludes>

URIs excluded from checking

schemes: HashSet<String>

Only check URIs with the given schemes (e.g. https and http)

exclude_private_ips: bool

Example: 192.168.0.1

exclude_link_local_ips: bool

Example: 169.254.0.0

exclude_loopback_ips: bool

For IPv4: 127.0.0.1/8 For IPv6: ::1/128

exclude_mail: bool

Example: octocat@github.com

Implementations

impl Filter

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

Whether e-mails aren’t checked

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

Whether the IP address is excluded from checking

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

Whether the host is excluded from checking

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

Whether the scheme of the given URI is excluded

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

Determine whether a given Uri should be excluded.

Details

1. If any of the following conditions are met, the URI is excluded:

• If it’s a mail address and it’s configured to ignore mail addresses.
• If the IP address belongs to a type that is configured to exclude.
• If the host belongs to a type that is configured to exclude.
• If the scheme of URI is not the allowed scheme.

2. Decide whether the URI is presumably included or explicitly included:
   • When both excludes and includes rules are empty, it’s presumably included unless it’s a known false positive.
   • When the includes rules matches the URI, it’s explicitly included.
3. When it’s a known false positive pattern, it’s explicitly excluded.
4. Decide whether the URI is presumably excluded or explicitly excluded:
   • When excludes rules is empty, but includes rules doesn’t match the URI, it’s presumably excluded.
   • When the excludes rules matches the URI, it’s explicitly excluded.
   • When the excludes rules matches the URI, it’s explicitly excluded.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Filter

Returns the “default value” for a type.