Struct HostPattern 

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

Available on crate feature net only.

A compiled pattern for matching a Host.

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

use rama_net::address::{Domain, Host, HostPattern};

let pattern = HostPattern::sub(Domain::from_static("example.com"));
assert!(pattern.matches(Host::from_static("api.example.com").view()));
assert!(!pattern.matches(Host::LOCALHOST_IPV4.view()));

Implementations

impl HostPattern

pub const fn exact(host: Host) -> HostPattern

Match exactly one host.

This constructor performs no parsing.

pub fn sub(domain: Domain) -> HostPattern

Match a domain and all of its descendants.

This constructor performs no parsing.

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

Compile a flat case-insensitive host glob.

* matches any sequence of bytes, including dots. Matching is ASCII case-insensitive against HostRef::to_str, so a glob can match domain names and IP literals alike. A static string is borrowed by the compiled wildcard; an owned String transfers its allocation.

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

Parse a host pattern.

Plain hosts are exact, .example.com and *.example.com are domain subtree patterns, and other values containing * are flat host globs.

pub fn matches(&self, host: HostRef<'_>) -> bool

Return whether this pattern matches host.

Trait Implementations

impl Clone for HostPattern

fn clone(&self) -> HostPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostPattern

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 HostPattern

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

The associated error which can be returned from parsing.

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

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

impl TryFrom<Box<str>> for HostPattern

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

The type returned in the event of a conversion error.

fn try_from( pattern: Box<str>, ) -> Result<HostPattern, <HostPattern 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 HostPattern

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryIntoHostPattern for HostPattern