Struct Path 

pub struct Path(pub Address);

The Path header (RFC 3327 §4).

A route header, not a Contact-shaped one, and it has to be parsed with list semantics for the same reason Record-Route does: proxies each add their own value, and RFC 3261 §7.3 lets a comma-joined row stand for the same values on separate rows. Read a line at a time, a two-proxy path becomes one opaque string and the order — which is the entire content of a path vector — is lost.

Tuple Fields

0: Address

Implementations

impl Path

pub fn parse_list(value: &[u8]) -> Result<Vec<Self>, HeaderError>

Parse a header value that may carry several comma-separated addresses.

Methods from Deref<Target = Address>

pub fn param(&self, name: &str) -> Option<&[u8]>

The value of a header parameter.

pub fn tag(&self) -> Option<&[u8]>

The tag parameter, which identifies a dialog participant.

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Deref for Path

type Target = Address

The resulting type after dereferencing.

fn deref(&self) -> &Address

Dereferences the value.

impl TypedHeader for Path

fn decode(value: &[u8]) -> Result<Self, HeaderError>

Decodes the first address in the value; use Self::parse_list or crate::message::Headers::typed_all when every one is needed.

const NAME: HeaderName = HeaderName::Path

The header this type reads.

fn decode_list(value: &[u8]) -> Result<Vec<Self>, HeaderError>

Parse every value in one header row.

const VALIDATE_LIST: bool = false

Whether Headers::typed_all must collect and validate the complete field before yielding.

fn validate_list(_values: &[&Self]) -> Result<(), HeaderError>

Validate all decoded values of this field across the complete message.