Struct ProxyPathTemplate 

pub struct ProxyPathTemplate { /* private fields */ }

Available on crate feature net only.

The path-and-query URI Template of a MASQUE proxy.

It locates CONNECT-UDP tunnels on the proxy (RFC 9298 §2): scheme, host, port and credentials come from the ProxyAddress carrying it. The template is validated on construction: a level 3 or lower template whose path starts with /, naming both target_host and target_port, and using only simple ({x}) and form-style query ({?x}, {&x}) expressions. Other variables are allowed and expand empty. Cloning is cheap.

Implementations

impl ProxyPathTemplate

pub const CONNECT_UDP_DEFAULT: &'static str = "/.well-known/masque/udp/{target_host}/{target_port}/"

The default CONNECT-UDP template a proxy serves (RFC 9298 §2).

pub fn try_new( template: impl AsRef<str>, ) -> Result<ProxyPathTemplate, ProxyPathTemplateError>

Parse and validate a path-and-query template.

pub fn is_connect_udp_default(&self) -> bool

Whether this is the RFC 9298 default CONNECT-UDP template.

pub fn template(&self) -> &UriTemplate

The underlying URI Template.

pub fn target_host(&self) -> TemplateVariable

The target_host variable.

pub fn target_port(&self) -> TemplateVariable

The target_port variable.

pub fn as_str(&self) -> &str

The template text.

pub fn expand_target_to(&self, out: &mut String, host: &Host, port: u16)

Append the path and query for a target, leaving other variables empty.

pub fn expand_connect_udp_default_to(out: &mut String, host: &Host, port: u16)

Append the default CONNECT-UDP path for a target without parsing a template.

Trait Implementations

impl Clone for ProxyPathTemplate

fn clone(&self) -> ProxyPathTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyPathTemplate

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

Formats the value using the given formatter.

impl Display for ProxyPathTemplate

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

Formats the value using the given formatter.

impl Eq for ProxyPathTemplate

impl Hash for ProxyPathTemplate

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProxyPathTemplate

fn eq(&self, other: &ProxyPathTemplate) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProxyPathTemplate