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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
use super::error::{RatelimitError, RatelimitErrorType, RatelimitResult};
use hyper::header::{HeaderMap, HeaderValue};
use std::convert::TryFrom;
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum RatelimitHeaders {
GlobalLimited {
reset_after: u64,
},
None,
Present {
bucket: Option<String>,
global: bool,
limit: u64,
remaining: u64,
reset: u64,
reset_after: u64,
},
}
impl RatelimitHeaders {
pub const fn global(&self) -> bool {
match self {
Self::GlobalLimited { .. } => true,
Self::None => false,
Self::Present { global, .. } => *global,
}
}
}
impl TryFrom<&'_ HeaderMap<HeaderValue>> for RatelimitHeaders {
type Error = RatelimitError;
fn try_from(map: &'_ HeaderMap<HeaderValue>) -> RatelimitResult<Self> {
match parse_map(map) {
Ok(v) => Ok(v),
Err(why) => {
let headers = &[
"x-ratelimit-bucket",
"x-ratelimit-limit",
"x-ratelimit-remaining",
"x-ratelimit-reset",
];
if headers.iter().any(|k| map.contains_key(*k)) {
Err(why)
} else if map.contains_key("x-ratelimit-global") {
Ok(Self::GlobalLimited {
reset_after: header_int(map, "x-ratelimit-reset-after")?,
})
} else {
Ok(Self::None)
}
}
}
}
}
#[allow(clippy::cast_possible_truncation)]
fn parse_map(map: &HeaderMap<HeaderValue>) -> RatelimitResult<RatelimitHeaders> {
if let Ok(true) = header_bool(map, "x-ratelimit-global") {
let retry_after = header_int(map, "retry-after")?;
return Ok(RatelimitHeaders::GlobalLimited {
reset_after: retry_after,
});
}
let bucket = header_str(map, "x-ratelimit-bucket")
.ok()
.map(ToOwned::to_owned);
let limit = header_int(map, "x-ratelimit-limit")?;
let remaining = header_int(map, "x-ratelimit-remaining")?;
let reset = header_float(map, "x-ratelimit-reset")?;
#[allow(clippy::cast_sign_loss)]
let reset = (reset * 1000.).ceil() as u64;
let reset_after = header_float(map, "x-ratelimit-reset-after")?;
#[allow(clippy::cast_sign_loss)]
let reset_after = (reset_after * 1000.).ceil() as u64;
Ok(RatelimitHeaders::Present {
bucket,
global: false,
limit,
remaining,
reset,
reset_after,
})
}
fn header_bool(map: &HeaderMap<HeaderValue>, name: &'static str) -> RatelimitResult<bool> {
let value = map
.get(name)
.ok_or_else(|| RatelimitError::header_missing(name))?;
let text = value.to_str().map_err(|source| {
RatelimitError::header_not_utf8(name, value.as_bytes().to_owned(), source)
})?;
let end = text.parse().map_err(|source| RatelimitError {
kind: RatelimitErrorType::ParsingBoolText {
name,
text: text.to_owned(),
},
source: Some(Box::new(source)),
})?;
Ok(end)
}
fn header_float(map: &HeaderMap<HeaderValue>, name: &'static str) -> RatelimitResult<f64> {
let value = map
.get(name)
.ok_or_else(|| RatelimitError::header_missing(name))?;
let text = value.to_str().map_err(|source| {
RatelimitError::header_not_utf8(name, value.as_bytes().to_owned(), source)
})?;
let end = text.parse().map_err(|source| RatelimitError {
kind: RatelimitErrorType::ParsingFloatText {
name,
text: text.to_owned(),
},
source: Some(Box::new(source)),
})?;
Ok(end)
}
fn header_int(map: &HeaderMap<HeaderValue>, name: &'static str) -> RatelimitResult<u64> {
let value = map
.get(name)
.ok_or_else(|| RatelimitError::header_missing(name))?;
let text = value.to_str().map_err(|source| {
RatelimitError::header_not_utf8(name, value.as_bytes().to_owned(), source)
})?;
let end = text.parse().map_err(|source| RatelimitError {
kind: RatelimitErrorType::ParsingIntText {
name,
text: text.to_owned(),
},
source: Some(Box::new(source)),
})?;
Ok(end)
}
fn header_str<'a>(map: &'a HeaderMap<HeaderValue>, name: &'static str) -> RatelimitResult<&'a str> {
let value = map
.get(name)
.ok_or_else(|| RatelimitError::header_missing(name))?;
let text = value.to_str().map_err(|source| {
RatelimitError::header_not_utf8(name, value.as_bytes().to_owned(), source)
})?;
Ok(text)
}
#[cfg(test)]
mod tests {
use super::RatelimitHeaders;
use hyper::header::{HeaderMap, HeaderName, HeaderValue};
use std::{convert::TryFrom, error::Error};
#[test]
fn test_global() -> Result<(), Box<dyn Error>> {
let map = {
let mut map = HeaderMap::new();
map.insert(
HeaderName::from_static("x-ratelimit-global"),
HeaderValue::from_static("true"),
);
map.insert(
HeaderName::from_static("retry-after"),
HeaderValue::from_static("65"),
);
map
};
let headers = RatelimitHeaders::try_from(&map)?;
assert!(
matches!(headers, RatelimitHeaders::GlobalLimited { reset_after } if reset_after == 65)
);
Ok(())
}
}