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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use super::common::State;
use super::endpoint::Endpoint;

/// Container for conference participants (RFC 4575 Section 5.3).
#[derive(Debug, Clone, PartialEq, Eq, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct Users {
    /// Partial notification state for the user list.
    #[cfg_attr(
        feature = "serde",
        serde(rename = "@state", default, skip_serializing_if = "Option::is_none")
    )]
    pub state: Option<State>,
    /// Individual participant entries.
    #[cfg_attr(
        feature = "serde",
        serde(rename = "user", default, skip_serializing_if = "Vec::is_empty")
    )]
    pub users: Vec<User>,
}

impl Users {
    /// Create an empty users container.
    pub fn new() -> Self {
        Self::default()
    }

    /// Add a user.
    pub fn with_user(mut self, user: User) -> Self {
        self.users
            .push(user);
        self
    }
}

/// A conference participant (RFC 4575 Section 5.4).
///
/// A user represents a logical identity (SIP AOR) and may have multiple
/// endpoints (devices) connected simultaneously.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct User {
    /// Logical user SIP URI (required XML attribute).
    #[cfg_attr(feature = "serde", serde(rename = "@entity"))]
    pub entity: String,
    /// Partial notification state.
    #[cfg_attr(
        feature = "serde",
        serde(rename = "@state", default, skip_serializing_if = "Option::is_none")
    )]
    pub state: Option<State>,
    /// Human-readable name or extension number.
    #[cfg_attr(
        feature = "serde",
        serde(
            rename = "display-text",
            default,
            skip_serializing_if = "Option::is_none"
        )
    )]
    pub display_text: Option<String>,
    /// Alternative addresses of record (GRUUs, tel: URIs).
    #[cfg_attr(
        feature = "serde",
        serde(
            rename = "associated-aors",
            default,
            skip_serializing_if = "Option::is_none"
        )
    )]
    pub associated_aors: Option<super::types::Uris>,
    /// Participant roles (e.g. "participant", "organizer").
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub roles: Option<UserRoles>,
    /// Preferred languages per RFC 3066.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub languages: Option<String>,
    /// Focus URI for cascaded conference scenarios.
    #[cfg_attr(
        feature = "serde",
        serde(
            rename = "cascaded-focus",
            default,
            skip_serializing_if = "Option::is_none"
        )
    )]
    pub cascaded_focus: Option<String>,
    /// Connected devices/sessions for this user.
    #[cfg_attr(
        feature = "serde",
        serde(rename = "endpoint", default, skip_serializing_if = "Vec::is_empty")
    )]
    pub endpoints: Vec<Endpoint>,
}

impl User {
    /// Create a user with the given entity URI.
    pub fn new(entity: impl Into<String>) -> Self {
        Self {
            entity: entity.into(),
            state: None,
            display_text: None,
            associated_aors: None,
            roles: None,
            languages: None,
            cascaded_focus: None,
            endpoints: Vec::new(),
        }
    }

    /// Set the display text.
    pub fn with_display_text(mut self, text: impl Into<String>) -> Self {
        self.display_text = Some(text.into());
        self
    }

    /// Add an endpoint.
    pub fn with_endpoint(mut self, endpoint: Endpoint) -> Self {
        self.endpoints
            .push(endpoint);
        self
    }
}

/// Container for user role entries.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct UserRoles {
    /// Role name entries (e.g. "participant", "organizer").
    #[cfg_attr(
        feature = "serde",
        serde(rename = "entry", default, skip_serializing_if = "Vec::is_empty")
    )]
    pub entries: Vec<String>,
}