Skip to main content

SipCallId

Struct SipCallId 

Source
pub struct SipCallId<'a> { /* private fields */ }
Expand description

A Call-ID value, split on the one @ its grammar admits.

callid = word [ "@" word ] (RFC 3261 section 25.1). @ is not a word character, so the split is unambiguous and a second @ makes the value invalid rather than choosing a side.

host returns the second word, which section 8.1.1.4 leaves optional and does not require to be a hostname. Callers that need one parse it themselves; a value that carries something else is still a valid Call-ID.

use sip_header::SipCallId;

let id = SipCallId::parse("a84b4c76e66710@example.com")?;
assert_eq!(id.local(), "a84b4c76e66710");
assert_eq!(id.host(), Some("example.com"));

let bare = SipCallId::parse("f81d4fae7dec11d0a76500a0c91e6bf6")?;
assert_eq!(bare.host(), None);

Implementations§

Source§

impl<'a> SipCallId<'a>

Source

pub fn parse(raw: &'a str) -> Result<Self, SipCallIdError>

Parse a Call-ID header value.

Errors on an empty word or a character outside word — including a second @, whitespace, and the separators that would let a value carry a parameter or a second header line.

Source

pub fn as_str(&self) -> &'a str

The value as parsed.

Call-IDs are compared byte-by-byte (RFC 3261 section 8.1.1.4), so this is the form to compare and to hash.

Source

pub fn local(&self) -> &'a str

The first word — everything before the @, or the whole value.

Source

pub fn host(&self) -> Option<&'a str>

The second word, if the value carries one.

Trait Implementations§

Source§

impl<'a> Clone for SipCallId<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SipCallId<'a>

Source§

impl<'a> Debug for SipCallId<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SipCallId<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for SipCallId<'a>

Source§

impl<'a> Hash for SipCallId<'a>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> PartialEq for SipCallId<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for SipCallId<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for SipCallId<'a>

§

impl<'a> RefUnwindSafe for SipCallId<'a>

§

impl<'a> Send for SipCallId<'a>

§

impl<'a> Sync for SipCallId<'a>

§

impl<'a> Unpin for SipCallId<'a>

§

impl<'a> UnsafeUnpin for SipCallId<'a>

§

impl<'a> UnwindSafe for SipCallId<'a>

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.