Struct EditAutoModRule

pub struct EditAutoModRule<'a> { /* private fields */ }

Available on crate feature builder only.

A builder for creating or editing guild AutoMod rules.

Examples

See GuildId::create_automod_rule for details.

Discord docs

Implementations

impl<'a> EditAutoModRule<'a>

pub fn new() -> Self

Equivalent to Self::default.

pub fn name(self, name: impl Into<String>) -> Self

The display name of the rule.

pub fn event_type(self, event_type: EventType) -> Self

Set the event context the rule should be checked.

pub fn trigger(self, trigger: Trigger) -> Self

Set the type of content which can trigger the rule.

None: The trigger type can’t be edited after creation. Only its values.

pub fn actions(self, actions: Vec<Action>) -> Self

Set the actions which will execute when the rule is triggered.

pub fn enabled(self, enabled: bool) -> Self

Set whether the rule is enabled.

pub fn exempt_roles( self, roles: impl IntoIterator<Item = impl Into<RoleId>>, ) -> Self

Set roles that should not be affected by the rule.

Maximum of 20.

pub fn exempt_channels( self, channels: impl IntoIterator<Item = impl Into<ChannelId>>, ) -> Self

Set channels that should not be affected by the rule.

Maximum of 50.

pub fn audit_log_reason(self, reason: &'a str) -> Self

Sets the request’s audit log reason.

Trait Implementations

impl Builder for EditAutoModRule<'_>

Available on crate feature http only.

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates or edits an AutoMod Rule in a guild. Providing a RuleId will edit that corresponding rule, otherwise a new rule will be created.

Note: Requires the Manage Guild permission.

Errors

Returns Error::Http if the current user lacks permission, or if invalid data is given.

type Context<'ctx> = (GuildId, Option<RuleId>)

Additional data that’s only required when sending a request off to the API.

type Built = Rule

impl<'a> Clone for EditAutoModRule<'a>

fn clone(&self) -> EditAutoModRule<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EditAutoModRule<'a>

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

Formats the value using the given formatter.

impl Default for EditAutoModRule<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Serialize for EditAutoModRule<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.