twilight_http/request/guild/auto_moderation/
update_auto_moderation_rule.rs

1use crate::{
2    client::Client,
3    error::Error,
4    request::{self, AuditLogReason, Request, TryIntoRequest},
5    response::{Response, ResponseFuture},
6    routing::Route,
7};
8use serde::Serialize;
9use std::future::IntoFuture;
10use twilight_model::{
11    guild::auto_moderation::{
12        AutoModerationAction, AutoModerationEventType, AutoModerationRule,
13        AutoModerationTriggerMetadata,
14    },
15    id::{
16        marker::{AutoModerationRuleMarker, ChannelMarker, GuildMarker, RoleMarker},
17        Id,
18    },
19};
20use twilight_validate::request::{audit_reason as validate_audit_reason, ValidationError};
21
22#[derive(Serialize)]
23struct UpdateAutoModerationRuleFields<'a> {
24    actions: Option<&'a [AutoModerationAction]>,
25    enabled: Option<bool>,
26    event_type: Option<AutoModerationEventType>,
27    exempt_channels: Option<&'a [Id<ChannelMarker>]>,
28    exempt_roles: Option<&'a [Id<RoleMarker>]>,
29    name: Option<&'a str>,
30    trigger_metadata: Option<&'a AutoModerationTriggerMetadata>,
31}
32
33/// Update an auto moderation rule in a guild.
34///
35/// Requires the [`MANAGE_GUILD`] permission.
36///
37/// [`MANAGE_GUILD`]: twilight_model::guild::Permissions::MANAGE_GUILD
38#[must_use = "requests must be configured and executed"]
39pub struct UpdateAutoModerationRule<'a> {
40    auto_moderation_rule_id: Id<AutoModerationRuleMarker>,
41    fields: UpdateAutoModerationRuleFields<'a>,
42    guild_id: Id<GuildMarker>,
43    http: &'a Client,
44    reason: Result<Option<&'a str>, ValidationError>,
45}
46
47impl<'a> UpdateAutoModerationRule<'a> {
48    pub(crate) const fn new(
49        http: &'a Client,
50        guild_id: Id<GuildMarker>,
51        auto_moderation_rule_id: Id<AutoModerationRuleMarker>,
52    ) -> Self {
53        Self {
54            auto_moderation_rule_id,
55            fields: UpdateAutoModerationRuleFields {
56                actions: None,
57                enabled: None,
58                event_type: None,
59                exempt_channels: None,
60                exempt_roles: None,
61                name: None,
62                trigger_metadata: None,
63            },
64            guild_id,
65            http,
66            reason: Ok(None),
67        }
68    }
69
70    /// Set the list of actions.
71    pub const fn actions(mut self, actions: &'a [AutoModerationAction]) -> Self {
72        self.fields.actions = Some(actions);
73
74        self
75    }
76
77    /// Set whether the rule is enabled.
78    pub const fn enabled(mut self, enabled: bool) -> Self {
79        self.fields.enabled = Some(enabled);
80
81        self
82    }
83
84    /// Set the rule's event type.
85    pub const fn event_type(mut self, event_type: AutoModerationEventType) -> Self {
86        self.fields.event_type = Some(event_type);
87
88        self
89    }
90
91    /// Set the channels where the rule does not apply.
92    pub const fn exempt_channels(mut self, exempt_channels: &'a [Id<ChannelMarker>]) -> Self {
93        self.fields.exempt_channels = Some(exempt_channels);
94
95        self
96    }
97
98    /// Set the roles to which the rule does not apply.
99    pub const fn exempt_roles(mut self, exempt_roles: &'a [Id<RoleMarker>]) -> Self {
100        self.fields.exempt_roles = Some(exempt_roles);
101
102        self
103    }
104
105    /// Set the rule's name.
106    pub const fn name(mut self, name: &'a str) -> Self {
107        self.fields.name = Some(name);
108
109        self
110    }
111
112    /// Set the trigger metadata.
113    ///
114    /// Care must be taken to set the correct metadata based on the rule's type.
115    pub const fn trigger_metadata(
116        mut self,
117        trigger_metadata: &'a AutoModerationTriggerMetadata,
118    ) -> Self {
119        self.fields.trigger_metadata = Some(trigger_metadata);
120
121        self
122    }
123}
124
125impl<'a> AuditLogReason<'a> for UpdateAutoModerationRule<'a> {
126    fn reason(mut self, reason: &'a str) -> Self {
127        self.reason = validate_audit_reason(reason).and(Ok(Some(reason)));
128
129        self
130    }
131}
132
133impl IntoFuture for UpdateAutoModerationRule<'_> {
134    type Output = Result<Response<AutoModerationRule>, Error>;
135
136    type IntoFuture = ResponseFuture<AutoModerationRule>;
137
138    fn into_future(self) -> Self::IntoFuture {
139        let http = self.http;
140
141        match self.try_into_request() {
142            Ok(request) => http.request(request),
143            Err(source) => ResponseFuture::error(source),
144        }
145    }
146}
147
148impl TryIntoRequest for UpdateAutoModerationRule<'_> {
149    fn try_into_request(self) -> Result<Request, Error> {
150        let mut request = Request::builder(&Route::UpdateAutoModerationRule {
151            auto_moderation_rule_id: self.auto_moderation_rule_id.get(),
152            guild_id: self.guild_id.get(),
153        })
154        .json(&self.fields);
155
156        if let Some(reason) = self.reason.map_err(Error::validation)? {
157            request = request.headers(request::audit_header(reason)?);
158        }
159
160        request.build()
161    }
162}
twilight_http/request/guild/auto_moderation/update_auto_moderation_rule.rs

twilight_http/request/guild/auto_moderation/
update_auto_moderation_rule.rs
