ruma_events/room/
avatar.rs

1//! Types for the [`m.room.avatar`] event.
2//!
3//! [`m.room.avatar`]: https://spec.matrix.org/latest/client-server-api/#mroomavatar
4
5use js_int::UInt;
6use ruma_common::OwnedMxcUri;
7use ruma_macros::EventContent;
8use serde::{Deserialize, Serialize};
9
10use super::ThumbnailInfo;
11use crate::EmptyStateKey;
12
13/// The content of an `m.room.avatar` event.
14///
15/// A picture that is associated with the room.
16///
17/// This can be displayed alongside the room information.
18#[derive(Clone, Debug, Default, Deserialize, Serialize, EventContent)]
19#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
20#[ruma_event(type = "m.room.avatar", kind = State, state_key_type = EmptyStateKey)]
21pub struct RoomAvatarEventContent {
22    /// Information about the avatar image.
23    #[serde(skip_serializing_if = "Option::is_none")]
24    pub info: Option<Box<ImageInfo>>,
25
26    /// URL of the avatar image.
27    pub url: Option<OwnedMxcUri>,
28}
29
30impl RoomAvatarEventContent {
31    /// Create an empty `RoomAvatarEventContent`.
32    pub fn new() -> Self {
33        Self::default()
34    }
35}
36
37/// Metadata about an image (specific to avatars).
38#[derive(Clone, Debug, Default, Deserialize, Serialize)]
39#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
40pub struct ImageInfo {
41    /// The height of the image in pixels.
42    #[serde(rename = "h", skip_serializing_if = "Option::is_none")]
43    pub height: Option<UInt>,
44
45    /// The width of the image in pixels.
46    #[serde(rename = "w", skip_serializing_if = "Option::is_none")]
47    pub width: Option<UInt>,
48
49    /// The MIME type of the image, e.g. "image/png."
50    #[serde(skip_serializing_if = "Option::is_none")]
51    pub mimetype: Option<String>,
52
53    /// The file size of the image in bytes.
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub size: Option<UInt>,
56
57    /// Metadata about the image referred to in `thumbnail_url`.
58    #[serde(skip_serializing_if = "Option::is_none")]
59    pub thumbnail_info: Option<Box<ThumbnailInfo>>,
60
61    /// The URL to the thumbnail of the image.
62    #[serde(skip_serializing_if = "Option::is_none")]
63    pub thumbnail_url: Option<OwnedMxcUri>,
64
65    /// The [BlurHash](https://blurha.sh) for this image.
66    ///
67    /// This uses the unstable prefix in
68    /// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
69    #[cfg(feature = "unstable-msc2448")]
70    #[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
71    pub blurhash: Option<String>,
72}
73
74impl ImageInfo {
75    /// Create a new `ImageInfo` with all fields set to `None`.
76    pub fn new() -> Self {
77        Self::default()
78    }
79}
ruma_events/room/avatar.rs

ruma_events/room/
avatar.rs
