ruma_events/room/message/
gallery.rs

Help
1use std::borrow::Cow;
2
3use ruma_common::serde::JsonObject;
4use serde::{de::DeserializeOwned, Deserialize, Serialize};
5use serde_json::Value as JsonValue;
6
7use super::{
8    AudioMessageEventContent, FileMessageEventContent, FormattedBody, ImageMessageEventContent,
9    VideoMessageEventContent,
10};
11
12/// The payload for a gallery message.
13#[derive(Clone, Debug, Deserialize, Serialize)]
14#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
15pub struct GalleryMessageEventContent {
16    /// A human-readable description of the gallery.
17    pub body: String,
18
19    /// Formatted form of the message `body`.
20    #[serde(flatten)]
21    pub formatted: Option<FormattedBody>,
22
23    /// Item types for the media in the gallery.
24    pub itemtypes: Vec<GalleryItemType>,
25}
26
27impl GalleryMessageEventContent {
28    /// Creates a new `GalleryMessageEventContent`.
29    pub fn new(
30        body: String,
31        formatted: Option<FormattedBody>,
32        itemtypes: Vec<GalleryItemType>,
33    ) -> Self {
34        Self { body, formatted, itemtypes }
35    }
36}
37
38/// The content that is specific to each gallery item type variant.
39#[derive(Clone, Debug, Serialize)]
40#[serde(tag = "itemtype")]
41#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
42pub enum GalleryItemType {
43    /// An audio item.
44    #[serde(rename = "m.audio")]
45    Audio(AudioMessageEventContent),
46
47    /// A file item.
48    #[serde(rename = "m.file")]
49    File(FileMessageEventContent),
50
51    /// An image item.
52    #[serde(rename = "m.image")]
53    Image(ImageMessageEventContent),
54
55    /// A video item.
56    #[serde(rename = "m.video")]
57    Video(VideoMessageEventContent),
58
59    /// A custom item.
60    #[doc(hidden)]
61    #[serde(untagged)]
62    _Custom(CustomEventContent),
63}
64
65impl GalleryItemType {
66    /// Creates a new `GalleryItemType`.
67    ///
68    /// The `itemtype` and `body` are required fields.
69    /// Additionally it's possible to add arbitrary key/value pairs to the event content for custom
70    /// item types through the `data` map.
71    ///
72    /// Prefer to use the public variants of `GalleryItemType` where possible; this constructor is
73    /// meant be used for unsupported item types only and does not allow setting arbitrary data
74    /// for supported ones.
75    ///
76    /// # Errors
77    ///
78    /// Returns an error if the `itemtype` is known and serialization of `data` to the corresponding
79    /// `GalleryItemType` variant fails.
80    pub fn new(itemtype: &str, body: String, data: JsonObject) -> serde_json::Result<Self> {
81        fn deserialize_variant<T: DeserializeOwned>(
82            body: String,
83            mut obj: JsonObject,
84        ) -> serde_json::Result<T> {
85            obj.insert("body".into(), body.into());
86            serde_json::from_value(JsonValue::Object(obj))
87        }
88
89        Ok(match itemtype {
90            "m.audio" => Self::Audio(deserialize_variant(body, data)?),
91            "m.file" => Self::File(deserialize_variant(body, data)?),
92            "m.image" => Self::Image(deserialize_variant(body, data)?),
93            "m.video" => Self::Video(deserialize_variant(body, data)?),
94            _ => Self::_Custom(CustomEventContent { itemtype: itemtype.to_owned(), body, data }),
95        })
96    }
97
98    /// Returns a reference to the `itemtype` string.
99    pub fn itemtype(&self) -> &str {
100        match self {
101            Self::Audio(_) => "m.audio",
102            Self::File(_) => "m.file",
103            Self::Image(_) => "m.image",
104            Self::Video(_) => "m.video",
105            Self::_Custom(c) => &c.itemtype,
106        }
107    }
108
109    /// Return a reference to the itemtype body.
110    pub fn body(&self) -> &str {
111        match self {
112            GalleryItemType::Audio(m) => &m.body,
113            GalleryItemType::File(m) => &m.body,
114            GalleryItemType::Image(m) => &m.body,
115            GalleryItemType::Video(m) => &m.body,
116            GalleryItemType::_Custom(m) => &m.body,
117        }
118    }
119
120    /// Returns the associated data.
121    ///
122    /// The returned JSON object won't contain the `itemtype` and `body` fields, use
123    /// [`.itemtype()`][Self::itemtype] / [`.body()`](Self::body) to access those.
124    ///
125    /// Prefer to use the public variants of `GalleryItemType` where possible; this method is meant
126    /// to be used for custom message types only.
127    pub fn data(&self) -> Cow<'_, JsonObject> {
128        fn serialize<T: Serialize>(obj: &T) -> JsonObject {
129            match serde_json::to_value(obj).expect("item type serialization to succeed") {
130                JsonValue::Object(mut obj) => {
131                    obj.remove("body");
132                    obj
133                }
134                _ => panic!("all item types must serialize to objects"),
135            }
136        }
137
138        match self {
139            Self::Audio(d) => Cow::Owned(serialize(d)),
140            Self::File(d) => Cow::Owned(serialize(d)),
141            Self::Image(d) => Cow::Owned(serialize(d)),
142            Self::Video(d) => Cow::Owned(serialize(d)),
143            Self::_Custom(c) => Cow::Borrowed(&c.data),
144        }
145    }
146}
147
148/// The payload for a custom item type.
149#[doc(hidden)]
150#[derive(Clone, Debug, Deserialize, Serialize)]
151pub struct CustomEventContent {
152    /// A custom itemtype.
153    itemtype: String,
154
155    /// The message body.
156    body: String,
157
158    /// Remaining event content.
159    #[serde(flatten)]
160    data: JsonObject,
161}
ruma_events/room/message/gallery.rs

ruma_events/room/message/
gallery.rs
