Skip to main content

NameAddr

Struct NameAddr 

Source
#[non_exhaustive]
pub struct NameAddr { /* private fields */ }
๐Ÿ‘ŽDeprecated since 0.2.0:

name-addr is header-level grammar; use sip_header::SipHeaderAddr or parse the URI with sip_uri::Uri directly

Expand description

A SIP name-addr: optional display name with a URI.

Parses the following forms:

  • "Display Name" <sip:user@host>
  • <sip:user@host>
  • sip:user@host (bare URI, no display name)

Deprecated since 0.2.0, will be removed in 0.3.0.

The name-addr production (RFC 3261 ยง25.1) appears inside SIP header fields like From, To, Contact, and Refer-To, where it is followed by header-level parameters (;tag=, ;expires=, etc.). This type rejects those parameters, so it cannot round-trip real SIP header values.

ยงMigration

  • Full SIP header parsing: use SipHeaderAddr from the sip-header crate, which handles display names, URIs, and header-level parameters.
  • URI only: parse directly with Uri.

Implementationsยง

Sourceยง

impl NameAddr

Source

pub fn new(uri: Uri) -> Self

Create a new NameAddr with the given URI and no display name.

Source

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

Set the display name.

Source

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

The display name, if present.

Source

pub fn uri(&self) -> &Uri

The URI.

Source

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

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

Source

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

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

Source

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

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

Trait Implementationsยง

Sourceยง

impl Clone for NameAddr

Sourceยง

fn clone(&self) -> NameAddr

Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Debug for NameAddr

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Display for NameAddr

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl FromStr for NameAddr

Sourceยง

type Err = ParseNameAddrError

The associated error which can be returned from parsing.
Sourceยง

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

Parses a string s to return a value of this type. Read more
Sourceยง

impl PartialEq for NameAddr

Sourceยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

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

impl Eq for NameAddr

Sourceยง

impl StructuralPartialEq for NameAddr

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T> ToString for T
where T: Display + ?Sized,

Sourceยง

fn to_string(&self) -> String

Converts the given value to a String. Read more
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.