1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
//! Modules and types for events in the `m.policy.rule` namespace.
use ruma_common::serde::StringEnum;
use serde::{Deserialize, Serialize};
use crate::PrivOwnedStr;
pub mod room;
pub mod server;
pub mod user;
/// The payload for policy rule events.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct PolicyRuleEventContent {
/// The entity affected by this rule.
///
/// Glob characters `*` and `?` can be used to match zero or more characters or exactly one
/// character respectively.
pub entity: String,
/// The suggested action to take.
pub recommendation: Recommendation,
/// The human-readable description for the recommendation.
pub reason: String,
}
impl PolicyRuleEventContent {
/// Creates a new `PolicyRuleEventContent` with the given entity, recommendation and reason.
pub fn new(entity: String, recommendation: Recommendation, reason: String) -> Self {
Self { entity, recommendation, reason }
}
}
/// The possibly redacted form of [`PolicyRuleEventContent`].
///
/// This type is used when it's not obvious whether the content is redacted or not.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct PossiblyRedactedPolicyRuleEventContent {
/// The entity affected by this rule.
///
/// Glob characters `*` and `?` can be used to match zero or more characters or exactly one
/// character respectively.
#[serde(skip_serializing_if = "Option::is_none")]
pub entity: Option<String>,
/// The suggested action to take.
#[serde(skip_serializing_if = "Option::is_none")]
pub recommendation: Option<Recommendation>,
/// The human-readable description for the recommendation.
#[serde(skip_serializing_if = "Option::is_none")]
pub reason: Option<String>,
}
/// The possible actions that can be taken.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, PartialEq, Eq, StringEnum)]
#[non_exhaustive]
pub enum Recommendation {
/// Entities affected by the rule should be banned from participation where possible.
#[ruma_enum(rename = "m.ban")]
Ban,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}