ruma_common/
power_levels.rs

Help
1//! Common types for the [`m.room.power_levels` event][power_levels].
2//!
3//! [power_levels]: https://spec.matrix.org/latest/client-server-api/#mroompower_levels
4
5use js_int::{int, Int};
6use serde::{Deserialize, Serialize};
7
8/// The power level requirements for specific notification types.
9#[derive(Clone, Debug, Deserialize, Serialize)]
10#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
11pub struct NotificationPowerLevels {
12    /// The level required to trigger an `@room` notification.
13    #[serde(
14        default = "default_power_level",
15        deserialize_with = "crate::serde::deserialize_v1_powerlevel"
16    )]
17    pub room: Int,
18}
19
20impl NotificationPowerLevels {
21    /// Create a new `NotificationPowerLevels` with all-default values.
22    pub fn new() -> Self {
23        Self { room: default_power_level() }
24    }
25
26    /// Value associated with the given `key`.
27    pub fn get(&self, key: &str) -> Option<&Int> {
28        match key {
29            "room" => Some(&self.room),
30            _ => None,
31        }
32    }
33
34    /// Whether all fields have their default values.
35    pub fn is_default(&self) -> bool {
36        self.room == default_power_level()
37    }
38}
39
40impl Default for NotificationPowerLevels {
41    fn default() -> Self {
42        Self::new()
43    }
44}
45
46/// Used to default power levels to 50 during deserialization.
47pub fn default_power_level() -> Int {
48    int!(50)
49}
ruma_common/power_levels.rs

ruma_common/
power_levels.rs
