ruma_events/room/message/
location.rs

Help
1#[cfg(feature = "unstable-msc3488")]
2use ruma_common::MilliSecondsSinceUnixEpoch;
3use serde::{Deserialize, Serialize};
4
5use crate::room::{MediaSource, ThumbnailInfo};
6#[cfg(feature = "unstable-msc3488")]
7use crate::{
8    location::{AssetContent, AssetType, LocationContent},
9    message::{TextContentBlock, TextRepresentation},
10};
11
12/// The payload for a location message.
13#[derive(Clone, Debug, Deserialize, Serialize)]
14#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
15#[cfg_attr(
16    feature = "unstable-msc3488",
17    serde(
18        from = "super::content_serde::msc3488::LocationMessageEventContentSerDeHelper",
19        into = "super::content_serde::msc3488::LocationMessageEventContentSerDeHelper"
20    )
21)]
22pub struct LocationMessageEventContent {
23    /// A description of the location e.g. "Big Ben, London, UK", or some kind of content
24    /// description for accessibility, e.g. "location attachment".
25    pub body: String,
26
27    /// A geo URI representing the location.
28    pub geo_uri: String,
29
30    /// Info about the location being represented.
31    #[serde(skip_serializing_if = "Option::is_none")]
32    pub info: Option<Box<LocationInfo>>,
33
34    /// Extensible-event text representation of the message.
35    ///
36    /// If present, this should be preferred over the `body` field.
37    #[cfg(feature = "unstable-msc3488")]
38    pub message: Option<TextContentBlock>,
39
40    /// Extensible-event location info of the message.
41    ///
42    /// If present, this should be preferred over the `geo_uri` field.
43    #[cfg(feature = "unstable-msc3488")]
44    pub location: Option<LocationContent>,
45
46    /// Extensible-event asset this message refers to.
47    #[cfg(feature = "unstable-msc3488")]
48    pub asset: Option<AssetContent>,
49
50    /// Extensible-event timestamp this message refers to.
51    #[cfg(feature = "unstable-msc3488")]
52    pub ts: Option<MilliSecondsSinceUnixEpoch>,
53}
54
55impl LocationMessageEventContent {
56    /// Creates a new `LocationMessageEventContent` with the given body and geo URI.
57    pub fn new(body: String, geo_uri: String) -> Self {
58        Self {
59            #[cfg(feature = "unstable-msc3488")]
60            message: Some(vec![TextRepresentation::plain(&body)].into()),
61            #[cfg(feature = "unstable-msc3488")]
62            location: Some(LocationContent::new(geo_uri.clone())),
63            #[cfg(feature = "unstable-msc3488")]
64            asset: Some(AssetContent::default()),
65            #[cfg(feature = "unstable-msc3488")]
66            ts: None,
67            body,
68            geo_uri,
69            info: None,
70        }
71    }
72
73    /// Set the asset type of this `LocationMessageEventContent`.
74    #[cfg(feature = "unstable-msc3488")]
75    pub fn with_asset_type(mut self, asset: AssetType) -> Self {
76        self.asset = Some(AssetContent { type_: asset });
77        self
78    }
79
80    /// Set the timestamp of this `LocationMessageEventContent`.
81    #[cfg(feature = "unstable-msc3488")]
82    pub fn with_ts(mut self, ts: MilliSecondsSinceUnixEpoch) -> Self {
83        self.ts = Some(ts);
84        self
85    }
86
87    /// Get the `geo:` URI of this `LocationMessageEventContent`.
88    pub fn geo_uri(&self) -> &str {
89        #[cfg(feature = "unstable-msc3488")]
90        if let Some(uri) = self.location.as_ref().map(|l| &l.uri) {
91            return uri;
92        }
93
94        &self.geo_uri
95    }
96
97    /// Get the plain text representation of this `LocationMessageEventContent`.
98    pub fn plain_text_representation(&self) -> &str {
99        #[cfg(feature = "unstable-msc3488")]
100        if let Some(text) = self.message.as_ref().and_then(|m| m.find_plain()) {
101            return text;
102        }
103
104        &self.body
105    }
106
107    /// Get the asset type of this `LocationMessageEventContent`.
108    #[cfg(feature = "unstable-msc3488")]
109    pub fn asset_type(&self) -> AssetType {
110        self.asset.as_ref().map(|a| a.type_.clone()).unwrap_or_default()
111    }
112}
113
114/// Thumbnail info associated with a location.
115#[derive(Clone, Debug, Default, Deserialize, Serialize)]
116#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
117pub struct LocationInfo {
118    /// The source of a thumbnail of the location.
119    #[serde(
120        flatten,
121        with = "crate::room::thumbnail_source_serde",
122        skip_serializing_if = "Option::is_none"
123    )]
124    pub thumbnail_source: Option<MediaSource>,
125
126    /// Metadata about the image referred to in `thumbnail_source.
127    #[serde(skip_serializing_if = "Option::is_none")]
128    pub thumbnail_info: Option<Box<ThumbnailInfo>>,
129}
130
131impl LocationInfo {
132    /// Creates an empty `LocationInfo`.
133    pub fn new() -> Self {
134        Self::default()
135    }
136}
ruma_events/room/message/location.rs

ruma_events/room/message/
location.rs
