1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
use crate::request::prelude::*;
use std::{
error::Error,
fmt::{Display, Formatter, Result as FmtResult},
};
use twilight_model::{
guild::audit_log::{AuditLog, AuditLogEvent},
id::{GuildId, UserId},
};
/// The error returned when the audit log can not be requested as configured.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum GetAuditLogError {
/// The limit is either 0 or more than 100.
LimitInvalid {
/// Provided maximum number of audit logs to get.
limit: u64,
},
}
impl Display for GetAuditLogError {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
match self {
Self::LimitInvalid { .. } => f.write_str("the limit is invalid"),
}
}
}
impl Error for GetAuditLogError {}
#[derive(Default)]
struct GetAuditLogFields {
action_type: Option<AuditLogEvent>,
before: Option<u64>,
limit: Option<u64>,
user_id: Option<UserId>,
}
/// Get the audit log for a guild.
///
/// # Examples
///
/// ```rust,no_run
/// use twilight_http::Client;
/// use twilight_model::id::GuildId;
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = Client::new("token");
///
/// let guild_id = GuildId(101);
/// let audit_log = client
/// // not done
/// .audit_log(guild_id)
/// .await?;
/// # Ok(()) }
/// ```
pub struct GetAuditLog<'a> {
fields: GetAuditLogFields,
fut: Option<Pending<'a, Option<AuditLog>>>,
guild_id: GuildId,
http: &'a Client,
}
impl<'a> GetAuditLog<'a> {
pub(crate) fn new(http: &'a Client, guild_id: GuildId) -> Self {
Self {
fields: GetAuditLogFields::default(),
fut: None,
guild_id,
http,
}
}
/// Filter by an action type.
pub fn action_type(mut self, action_type: AuditLogEvent) -> Self {
self.fields.action_type.replace(action_type);
self
}
/// Get audit log entries before the entry specified.
pub fn before(mut self, before: u64) -> Self {
self.fields.before.replace(before);
self
}
/// Set the maximum number of audit logs to retrieve.
///
/// The minimum is 1 and the maximum is 100.
///
/// # Errors
///
/// Returns [`GetAuditLogError::LimitInvalid`] if the `limit` is 0 or
/// greater than 100.
///
/// [`GetAuditLogError::LimitInvalid`]: enum.GetAuditLogError.html#variant.LimitInvalid
pub fn limit(mut self, limit: u64) -> Result<Self, GetAuditLogError> {
if !validate::get_audit_log_limit(limit) {
return Err(GetAuditLogError::LimitInvalid { limit });
}
self.fields.limit.replace(limit);
Ok(self)
}
/// Filter audit log for entries from a user.
///
/// This is the user who did the auditable action, not the target of the auditable action.
pub fn user_id(mut self, user_id: UserId) -> Self {
self.fields.user_id.replace(user_id);
self
}
fn start(&mut self) -> Result<()> {
self.fut.replace(Box::pin(self.http.request(Request::from(
Route::GetAuditLogs {
action_type: self.fields.action_type.map(|x| x as u64),
before: self.fields.before,
guild_id: self.guild_id.0,
limit: self.fields.limit,
user_id: self.fields.user_id.map(|x| x.0),
},
))));
Ok(())
}
}
poll_req!(GetAuditLog<'_>, Option<AuditLog>);