ruma_events/room/message/
server_notice.rs

1use ruma_common::serde::StringEnum;
2use serde::{Deserialize, Serialize};
3
4use crate::PrivOwnedStr;
5
6/// The payload for a server notice message.
7#[derive(Clone, Debug, Deserialize, Serialize)]
8#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
9pub struct ServerNoticeMessageEventContent {
10    /// A human-readable description of the notice.
11    pub body: String,
12
13    /// The type of notice being represented.
14    pub server_notice_type: ServerNoticeType,
15
16    /// A URI giving a contact method for the server administrator.
17    ///
18    /// Required if the notice type is `m.server_notice.usage_limit_reached`.
19    #[serde(skip_serializing_if = "Option::is_none")]
20    pub admin_contact: Option<String>,
21
22    /// The kind of usage limit the server has exceeded.
23    ///
24    /// Required if the notice type is `m.server_notice.usage_limit_reached`.
25    #[serde(skip_serializing_if = "Option::is_none")]
26    pub limit_type: Option<LimitType>,
27}
28
29impl ServerNoticeMessageEventContent {
30    /// Creates a new `ServerNoticeMessageEventContent` with the given body and notice type.
31    pub fn new(body: String, server_notice_type: ServerNoticeType) -> Self {
32        Self { body, server_notice_type, admin_contact: None, limit_type: None }
33    }
34}
35
36/// Types of server notices.
37#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
38#[derive(Clone, PartialEq, Eq, StringEnum)]
39#[non_exhaustive]
40pub enum ServerNoticeType {
41    /// The server has exceeded some limit which requires the server administrator to intervene.
42    #[ruma_enum(rename = "m.server_notice.usage_limit_reached")]
43    UsageLimitReached,
44
45    #[doc(hidden)]
46    _Custom(PrivOwnedStr),
47}
48
49/// Types of usage limits.
50#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
51#[derive(Clone, PartialEq, Eq, StringEnum)]
52#[ruma_enum(rename_all = "snake_case")]
53#[non_exhaustive]
54pub enum LimitType {
55    /// The server's number of active users in the last 30 days has exceeded the maximum.
56    ///
57    /// New connections are being refused by the server. What defines "active" is left as an
58    /// implementation detail, however servers are encouraged to treat syncing users as "active".
59    MonthlyActiveUser,
60
61    #[doc(hidden)]
62    _Custom(PrivOwnedStr),
63}
ruma_events/room/message/server_notice.rs

ruma_events/room/message/
server_notice.rs
