Struct ActionExecution

#[non_exhaustive]
pub struct ActionExecution {
    pub guild_id: GuildId,
    pub action: Action,
    pub rule_id: RuleId,
    pub trigger_type: TriggerType,
    pub user_id: UserId,
    pub channel_id: Option<ChannelId>,
    pub message_id: Option<MessageId>,
    pub alert_system_message_id: Option<MessageId>,
    pub content: String,
    pub matched_keyword: Option<String>,
    pub matched_content: Option<String>,
}

Gateway event payload sent when a rule is triggered and an action is executed (e.g. message is blocked).

Discord docs.

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.

guild_id: GuildId

ID of the guild in which the action was executed.

action: Action

Action which was executed.

rule_id: RuleId

ID of the rule which action belongs to.

trigger_type: TriggerType

Trigger type of rule which was triggered.

user_id: UserId

ID of the user which generated the content which triggered the rule.

channel_id: Option<ChannelId>

ID of the channel in which user content was posted.

message_id: Option<MessageId>

ID of any user message which content belongs to.

Will be None if message was blocked by automod or content was not part of any message.

alert_system_message_id: Option<MessageId>

ID of any system auto moderation messages posted as a result of this action.

Will be None if this event does not correspond to an action with type Action::Alert.

content: String

User generated text content.

Requires GatewayIntents::MESSAGE_CONTENT to receive non-empty values.

matched_keyword: Option<String>

Word or phrase configured in the rule that triggered the rule.

matched_content: Option<String>

Substring in content that triggered the rule.

Requires GatewayIntents::MESSAGE_CONTENT to receive non-empty values.

Trait Implementations

impl Clone for ActionExecution

fn clone(&self) -> ActionExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionExecution

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ActionExecution

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ActionExecution

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

where __S: Serializer,

Serialize this value into the given Serde serializer.