Struct SipHeaderAddr 

#[non_exhaustive]
pub struct SipHeaderAddr { /* private fields */ }

A SIP header field value containing a name-addr or addr-spec with header-level parameters (RFC 3261 S20).

Handles the full grammar: (name-addr / addr-spec) *(SEMI generic-param)

Used for SIP headers like From, To, Contact, P-Asserted-Identity, and Refer-To where parameters like ;tag=, ;expires=, and ;serviceurn= follow the URI.

use freeswitch_types::variables::SipHeaderAddr;

let addr: SipHeaderAddr = r#""Alice" <sip:alice@example.com>;tag=abc123"#.parse().unwrap();
assert_eq!(addr.display_name(), Some("Alice"));
assert_eq!(addr.tag(), Some("abc123"));

Display always emits angle brackets around the URI, even for bare addr-spec input. This is the canonical form required by RFC 3261 when header-level parameters are present.

Implementations

impl SipHeaderAddr

pub fn new(uri: Uri) -> Self

Create a new SipHeaderAddr with the given URI and no display name or params.

pub fn with_display_name(self, name: impl Into<String>) -> Self

Set the display name.

pub fn with_param( self, key: impl Into<String>, value: Option<impl Into<String>>, ) -> Self

Add a header-level parameter. The key is lowercased on insertion.

pub fn display_name(&self) -> Option<&str>

The display name, if present.

pub fn uri(&self) -> &Uri

The URI.

pub fn sip_uri(&self) -> Option<&SipUri>

If the URI is a SIP/SIPS URI, return a reference to it.

pub fn tel_uri(&self) -> Option<&TelUri>

If the URI is a tel: URI, return a reference to it.

pub fn urn_uri(&self) -> Option<&UrnUri>

If the URI is a URN, return a reference to it.

pub fn params(&self) -> impl Iterator<Item = (&str, Option<&str>)>

Iterator over header-level parameters as (key, value) pairs. Keys are lowercased; values are preserved as-is.

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

Look up a header-level parameter by name (case-insensitive).

Returns Some(Some(value)) if the param has a value, Some(None) if it is a flag param (no value), None if the param is not present.

pub fn tag(&self) -> Option<&str>

The tag parameter value, if present.

Trait Implementations

impl Clone for SipHeaderAddr

fn clone(&self) -> SipHeaderAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipHeaderAddr

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

Formats the value using the given formatter.

impl Display for SipHeaderAddr

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

Formats the value using the given formatter.

impl FromStr for SipHeaderAddr

type Err = ParseSipHeaderAddrError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

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

impl PartialEq for SipHeaderAddr

fn eq(&self, other: &SipHeaderAddr) -> 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 SipHeaderAddr

impl StructuralPartialEq for SipHeaderAddr