Struct Pattern

pub struct Pattern { /* private fields */ }

A parsed WebExtensions pattern

Format

A strict format looks like SCHEMA://HOST/PATH:

• SCHEMA can be * (all schemas), or a specific schema like http
• HOST can be * (all hosts), a specific host (no wildcards allowed) like google.com, or something starting with *. to indicate that the domain itself and any subdomain is valid, like *.google.com
• PATH is a string that is matched against the full path, and SCHEMA://HOST/ is considered to only match the path /. It supports wildcards with *, which will match any character (including a slash)

The value <all_urls> is a special token that matches all URLs.

The relaxed format is a superset of the strict format, and you can optionally omit the schema and the path – omitting SCHEMA:// will match all schemas, and omitting the path (or leaving it as /) will match all paths. relaxed formats also do case insensitive path matching.

Examples

use webextension_pattern::Pattern;
use url::Url;
let p = Pattern::new("*://google.com/foo*bar", false)?;
assert!(!p.is_match(&Url::parse("http://google.com/")?));
assert!(p.is_match(&Url::parse("https://google.com/foo/baz/bar")?));
assert!(p.is_match(&Url::parse("https://google.com/foo_bar")?));
assert!(!p.is_match(&Url::parse("https://mail.google.com/foo_bar")?));

let p = Pattern::new("*.google.com", true)?;
assert!(p.is_match(&Url::parse("http://google.com/")?));
assert!(p.is_match(&Url::parse("https://google.com/foo_bar")?));
assert!(p.is_match(&Url::parse("https://mail.google.com/something_else")?));

Implementations

impl Pattern

pub fn wildcard() -> Pattern

Return a pattern that will match any URL

pub fn new(source: &str, relaxed: bool) -> Result<Pattern, Error>

Parse a pattern from the given source. If using relaxed, it will not adhere to the requirements of the Mozilla format by allowing the omission of an URL scheme and the omission of an explicit path, causing it to assume these as wildcards. This mode is intended to be more forgiving for common user patterns.

pub fn is_match(&self, url: &Url) -> bool

Check if the Pattern matches the url.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl Display for Pattern

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

Formats the value using the given formatter.

impl Into<String> for Pattern

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl TryFrom<String> for Pattern

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: String) -> Result<Self, Error>

Performs the conversion.