Struct ruma::events::policy::rule::PolicyRuleEventContent

#[non_exhaustive]
pub struct PolicyRuleEventContent {
    pub entity: String,
    pub recommendation: Recommendation,
    pub reason: String,
}

The payload for policy rule events.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entity: String

The entity affected by this rule.

Glob characters * and ? can be used to match zero or more characters or exactly one character respectively.

recommendation: Recommendation

The suggested action to take.

reason: String

The human-readable description for the recommendation.

Implementations

impl PolicyRuleEventContent

pub fn new( entity: String, recommendation: Recommendation, reason: String, ) -> PolicyRuleEventContent

Creates a new PolicyRuleEventContent with the given entity, recommendation and reason.

Trait Implementations

impl Clone for PolicyRuleEventContent

fn clone(&self) -> PolicyRuleEventContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PolicyRuleEventContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PolicyRuleEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<PolicyRuleEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PolicyRuleEventContent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.