sip-header 1.0.0-beta.2

SIP header field parsers: Via, Warning, Auth, Accept, Contact, Call-Info, History-Info, Geolocation, Security, and full IANA header catalog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! RFC 3911 `Join` header parser.

use crate::dialog_id::{DialogBuild, DialogFields, DialogFraming, DialogId};

/// A `Join` header value (RFC 3911 ยง7.1): `callid *(SEMI join-param)`
/// with the mandatory `to-tag` and `from-tag`.
///
/// Parsed through [`HeaderParse`](crate::HeaderParse) and [`UriHeaderParse`](crate::UriHeaderParse).
///
/// Join defines no `early-only`; one on the wire is an ordinary parameter.
///
/// ```
/// use sip_header::{HeaderParse, SipJoin};
///
/// let join = SipJoin::parse("abc@203.0.113.5;to-tag=t1;from-tag=f1;early-only")?;
/// assert_eq!(join.to_tag(), "t1");
/// assert_eq!(join.param("early-only"), Some(None));
/// # Ok::<(), sip_header::ParseError>(())
/// ```
///
/// # Equality
///
/// Two values are equal when their wire forms in the same framing are:
/// Call-ID and tags byte for byte, parameters as
/// [`HeaderParams`](crate::HeaderParams) compares them. [`Hash`] follows
/// the same rule.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub struct SipJoin(DialogId);

dialog_id_type!(SipJoin, to_tag, with_to_tag => "to-tag", from_tag, with_from_tag => "from-tag", early_only: false);

#[cfg(feature = "serde")]
serde_parts!(SipJoin, SipJoinParts);

#[cfg(feature = "serde")]
#[derive(serde::Serialize, serde::Deserialize)]
#[serde(deny_unknown_fields)]
struct SipJoinParts {
    #[serde(deserialize_with = "crate::serde_parts::field::call_id")]
    call_id: String,
    #[serde(deserialize_with = "crate::serde_parts::field::to_tag")]
    to_tag: String,
    #[serde(deserialize_with = "crate::serde_parts::field::from_tag")]
    from_tag: String,
    #[serde(default, deserialize_with = "crate::params::deserialize_unchecked")]
    params: crate::HeaderParams,
    #[serde(default, deserialize_with = "crate::serde_parts::field::framing")]
    framing: DialogFraming,
}

#[cfg(feature = "serde")]
impl SipJoinParts {
    fn into_value(p: Self) -> Result<SipJoin, crate::ParseError> {
        let fields = DialogFields {
            call_id: p.call_id,
            first_tag: p.to_tag,
            second_tag: p.from_tag,
            early_only: false,
            params: p.params,
        };
        crate::dialog_id::reads_back(SipJoin::build(fields, p.framing))
    }

    fn from_value(j: SipJoin) -> Self {
        SipJoinParts {
            call_id: j
                .call_id()
                .to_string(),
            to_tag: j
                .to_tag()
                .to_string(),
            from_tag: j
                .from_tag()
                .to_string(),
            params: j
                .params()
                .clone(),
            framing: j.framing(),
        }
    }
}

impl DialogBuild for SipJoin {
    fn build(fields: DialogFields, framing: DialogFraming) -> Self {
        Self(DialogId::from_fields(fields, framing))
    }

    #[cfg(feature = "serde")]
    fn dialog(&self) -> &DialogId {
        &self.0
    }
}

dialog_id_parse!(SipJoin);