Struct SipTargetDialog 

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

A parsed Target-Dialog header value (RFC 4538 §7).

Identifies an existing dialog: Call-ID plus the mandatory local-tag and remote-tag, both from the perspective of the request recipient.

Implementations

impl SipTargetDialog

pub fn parse(raw: &str) -> Result<Self, SipTargetDialogError>

Parse a wire-form header value: callid;local-tag=x;remote-tag=y.

pub fn parse_uri_header(raw: &str) -> Result<Self, SipTargetDialogError>

Parse the percent-encoded framing found in a URI header, e.g. callid%40host%3Blocal-tag%3Dx%3Bremote-tag%3Dy.

Accepts the canonicalised value returned by sip_uri::SipUri::header; Display re-encodes to that same canonical form (uppercase hex).

pub fn call_id(&self) -> &str

The Call-ID of the target dialog.

pub fn with_call_id( self, call_id: impl Into<String>, ) -> Result<Self, SipTargetDialogError>

Returns this value with a different Call-ID.

Framing, both tags and all generic parameters are preserved, so Display re-emits the parsed input with only the Call-ID changed.

Errors unless call_id is an RFC 3261 §25.1 callid = word [ "@" word ]. parse is lenient about this token; a value that never came off the wire is not.

use sip_header::SipTargetDialog;

let t = SipTargetDialog::parse("abc@203.0.113.5;local-tag=l1;remote-tag=r1")?
    .with_call_id("abc@example.com")?;
assert_eq!(t.to_string(), "abc@example.com;local-tag=l1;remote-tag=r1");

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

The host part of the Call-ID (after @), if present.

pub fn local_tag(&self) -> &str

The mandatory local-tag value.

pub fn remote_tag(&self) -> &str

The mandatory remote-tag value.

pub fn params(&self) -> &[(String, Option<String>)]

Returns all generic parameters (tags excluded).

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

Returns a specific generic parameter by key (case-insensitive).

Trait Implementations

impl Clone for SipTargetDialog

fn clone(&self) -> SipTargetDialog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipTargetDialog

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

Formats the value using the given formatter.

impl Display for SipTargetDialog

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

Formats the value using the given formatter.

impl Eq for SipTargetDialog

impl FromStr for SipTargetDialog

type Err = SipTargetDialogError

The associated error which can be returned from parsing.

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

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

impl PartialEq for SipTargetDialog

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SipTargetDialog