Struct PathSet 

pub struct PathSet(pub Vec<Address>);

The proxies a registrar recorded as being on the path back to this contact (RFC 3327).

Held and reported, not routed on. RFC 3327 §5.1 is explicit that “the general operation of the UA is to ignore the Path header field in the response” — the path vector exists so that requests arriving at the registrar can be routed toward a UA behind a NAT, and it is the registrar that walks it, not the UA. A UA that turned it into a pre-loaded route set would be sending its own requests through proxies that never asked to carry them; the header for that job is Service-Route (RFC 3608), which is a different list with different semantics.

What §5.1 does say it is for is inspection: “such inspection might allow the UA to detect intermediate proxies that have inappropriately added themselves”. That is only possible if the value survives, which is why it is kept rather than parsed and dropped.

Tuple Fields

0: Vec<Address>

Implementations

impl PathSet

pub fn hops(&self) -> &[Address]

The proxies, outermost first — the order they appeared in, which is the order a request travelling toward the UA would traverse them.

pub fn is_empty(&self) -> bool

Whether the registrar recorded no path at all.

pub fn rendered(&self) -> Vec<String>

Each hop rendered back to the form it arrived in, for logging and for comparison.

pub fn hops_outside(&self, expected: &[&str]) -> Vec<String>

Whether a proxy this side did not expect is on the path.

RFC 3327 §5.1 gives inspection as the UA’s reason to care: “such inspection might allow the UA to detect intermediate proxies that have inappropriately added themselves”. That judgement needs a policy the UA holds, so this asks the question and leaves the answer to the caller rather than inventing a trust rule here.

pub fn from_response(response: &Response) -> Self

Read the path vector out of a REGISTER response.

Parsed rather than kept as text, and kept as [Address] rather than as a URI, because the parameters are load-bearing: RFC 5626 §5.3 hangs the ob marker off a Path value, and T-15 needs to read it. A path vector flattened to a list of URIs would be syntactically fine and quietly useless for Outbound.

Trait Implementations

impl Clone for PathSet

fn clone(&self) -> PathSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathSet

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

Formats the value using the given formatter.

impl Default for PathSet

fn default() -> PathSet

Returns the “default value” for a type.

impl PartialEq for PathSet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PathSet