jmap_websocket/
capability.rs1use serde::{Deserialize, Serialize};
4
5#[non_exhaustive]
21#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
22#[serde(rename_all = "camelCase")]
23pub struct WebSocketCapability {
24 pub url: String,
27 #[serde(default)]
31 pub supports_push: bool,
32 #[serde(flatten, default, skip_serializing_if = "serde_json::Map::is_empty")]
34 pub extra: serde_json::Map<String, serde_json::Value>,
35}
36
37impl WebSocketCapability {
38 pub fn new(url: impl Into<String>, supports_push: bool) -> Self {
41 Self {
42 url: url.into(),
43 supports_push,
44 extra: serde_json::Map::new(),
45 }
46 }
47}
48
49#[cfg(test)]
50mod tests {
51 use super::*;
52 use serde_json::json;
53
54 const RFC_EXAMPLE: &str = r#"{
56 "url": "wss://server.example.com/jmap/ws/",
57 "supportsPush": true
58 }"#;
59
60 #[test]
61 fn rfc_8887_section_3_example_round_trips() {
62 let cap: WebSocketCapability = serde_json::from_str(RFC_EXAMPLE).unwrap();
63 assert_eq!(cap.url, "wss://server.example.com/jmap/ws/");
64 assert!(cap.supports_push);
65 assert!(cap.extra.is_empty());
66 let expected: serde_json::Value = serde_json::from_str(RFC_EXAMPLE).unwrap();
67 assert_eq!(serde_json::to_value(&cap).unwrap(), expected);
68 }
69
70 #[test]
73 fn unknown_member_is_preserved() {
74 let wire = json!({"url": "wss://h/ws", "supportsPush": false, "x-vendor": {"a": 1}});
75 let cap: WebSocketCapability = serde_json::from_value(wire.clone()).unwrap();
76 assert_eq!(cap.extra["x-vendor"], json!({"a": 1}));
77 assert_eq!(serde_json::to_value(&cap).unwrap(), wire);
78 }
79}