Struct DomainPattern 

pub struct DomainPattern(/* private fields */);

Available on crate feature net only.

A compiled pattern for matching validated domain names.

The representation is intentionally private. Construct patterns explicitly with exact, sub, or try_glob, or parse conventional pattern syntax through try_new.

use rama_net::address::{Domain, DomainPattern};

let pattern = DomainPattern::sub(Domain::from_static("example.com"));
assert!(pattern.matches(Domain::from_static("api.example.com").view()));
assert!(!pattern.matches(Domain::from_static("example.net").view()));

Implementations

impl DomainPattern

pub const fn exact(domain: Domain) -> DomainPattern

Match exactly one domain.

This constructor performs no parsing. A wildcard-valued Domain is treated literally; use Self::sub for subtree semantics.

pub fn sub(domain: Domain) -> DomainPattern

Match a domain and all of its descendants.

This constructor performs no parsing. If domain is already in Rama’s *.example.com wildcard form or its presentation has a leading dot, the stored subtree apex is normalized to example.com.

pub fn try_glob( pattern: impl Into<Cow<'static, str>>, ) -> Result<DomainPattern, Box<dyn Error + Sync + Send>>

Compile a case-insensitive domain glob.

* matches any sequence of bytes, including dots. Exact and subtree matching should use Self::exact and Self::sub instead. Domain globs are restricted to ASCII because wildcard-aware IDNA conversion is ambiguous; exact and subtree patterns retain the normal Domain IDNA behavior. A static string is borrowed by the compiled wildcard; an owned String transfers its allocation.

pub fn try_new( pattern: impl TryIntoDomainPattern, ) -> Result<DomainPattern, Box<dyn Error + Sync + Send>>

Parse a domain pattern.

Plain domains are exact, .example.com and *.example.com are subtree patterns, and other values containing * are globs.

pub fn matches(&self, domain: DomainRef<'_>) -> bool

Return whether this pattern matches domain.

Trait Implementations

impl Clone for DomainPattern

fn clone(&self) -> DomainPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DomainPattern

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

Formats the value using the given formatter.

impl From<DomainPattern> for HostPattern

Preserve a domain pattern’s exact, subtree, or glob semantics while widening its candidate type to Host.

fn from(pattern: DomainPattern) -> HostPattern

Converts to this type from the input type.

impl FromStr for DomainPattern

type Err = Box<dyn Error + Sync + Send>

The associated error which can be returned from parsing.

fn from_str( pattern: &str, ) -> Result<DomainPattern, <DomainPattern as FromStr>::Err>

Parses a string s to return a value of this type.

impl TryFrom<Box<str>> for DomainPattern

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( pattern: Box<str>, ) -> Result<DomainPattern, <DomainPattern as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<HostPattern> for DomainPattern

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( pattern: HostPattern, ) -> Result<DomainPattern, <DomainPattern as TryFrom<HostPattern>>::Error>

Performs the conversion.

impl TryFrom<String> for DomainPattern

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( pattern: String, ) -> Result<DomainPattern, <DomainPattern as TryFrom<String>>::Error>

Performs the conversion.

impl TryIntoDomainPattern for DomainPattern

impl TryIntoHostPattern for DomainPattern