Struct Rule

#[non_exhaustive]
pub struct Rule {
    pub id: RuleId,
    pub guild_id: GuildId,
    pub name: String,
    pub creator_id: UserId,
    pub event_type: EventType,
    pub trigger: Trigger,
    pub actions: Vec<Action>,
    pub enabled: bool,
    pub exempt_roles: Vec<RoleId>,
    pub exempt_channels: Vec<ChannelId>,
}

Configured auto moderation rule.

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.

id: RuleId

ID of the rule.

guild_id: GuildId

ID of the guild this rule belongs to.

name: String

Name of the rule.

creator_id: UserId

ID of the user which created the rule.

event_type: EventType

Event context in which the rule should be checked.

trigger: Trigger

Characterizes the type of content which can trigger the rule.

actions: Vec<Action>

Actions which will execute when the rule is triggered.

enabled: bool

Whether the rule is enabled.

exempt_roles: Vec<RoleId>

Roles that should not be affected by the rule.

Maximum of 20.

exempt_channels: Vec<ChannelId>

Channels that should not be affected by the rule.

Maximum of 50.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Rule

fn eq(&self, other: &Rule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Rule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Rule

impl StructuralPartialEq for Rule