Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mre/rate-limits
Parse HTTP Rate-Limit headers of different vendors
https://github.com/mre/rate-limits
http parser rate-limit rate-limiting
Last synced: 6 days ago
JSON representation
Parse HTTP Rate-Limit headers of different vendors
- Host: GitHub
- URL: https://github.com/mre/rate-limits
- Owner: mre
- Created: 2022-03-25T00:15:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T15:46:23.000Z (about 1 year ago)
- Last Synced: 2024-11-02T06:31:17.425Z (13 days ago)
- Topics: http, parser, rate-limit, rate-limiting
- Language: Rust
- Homepage: https://docs.rs/rate-limits
- Size: 70.3 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rate-limits
[](https://docs.rs/rate-limits)
A crate for parsing HTTP rate limit headers as per the [IETF draft][draft].
Inofficial implementations like the [Github rate limit headers][github] are
also supported on a best effort basis. See [vendor list] for support.
```rust
use indoc::indoc;
use std::str::FromStr;
use time::{OffsetDateTime, Duration};
use rate_limits::{Vendor, RateLimit, ResetTime, Headers};
let headers = indoc! {"
x-ratelimit-limit: 5000
x-ratelimit-remaining: 4987
x-ratelimit-reset: 1350085394
"};
assert_eq!(
RateLimit::new(headers).unwrap(),
RateLimit::Rfc6585(Headers {
limit: 5000,
remaining: 4987,
reset: ResetTime::DateTime(
OffsetDateTime::from_unix_timestamp(1350085394).unwrap()
),
window: Some(Duration::HOUR),
vendor: Vendor::Github
}),
);
```
Also takes the `Retry-After` header into account when calculating the reset
time.
[`http::HeaderMap`][headermap] is supported as well:
```rust
use std::str::FromStr;
use time::{OffsetDateTime, Duration};
use rate_limits::{Vendor, RateLimit, ResetTime, Headers};
use http::header::HeaderMap;
let mut headers = HeaderMap::new();
headers.insert("X-RATELIMIT-LIMIT", "5000".parse().unwrap());
headers.insert("X-RATELIMIT-REMAINING", "4987".parse().unwrap());
headers.insert("X-RATELIMIT-RESET", "1350085394".parse().unwrap());
assert_eq!(
RateLimit::new(headers).unwrap(),
RateLimit::Rfc6585(Headers {
limit: 5000,
remaining: 4987,
reset: ResetTime::DateTime(
OffsetDateTime::from_unix_timestamp(1350085394).unwrap()
),
window: Some(Duration::HOUR),
vendor: Vendor::Github
}),
);
```
### Further development
There is a new [IETF draft][draft_new] which supersedes the old "polli" draft.
It introduces a new `RateLimit-Policy` header which specifies the rate limit
quota policy. The goal is to support this new draft in this crate as well.
### Other resources:
- [Examples of HTTP API Rate Limiting HTTP Response][stackoverflow]
[draft]: https://datatracker.ietf.org/doc/html/draft-polli-ratelimit-headers-00
[draft_new]: https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/
[headers]: https://stackoverflow.com/a/16022625/270334
[github]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api
[vendor list]: https://docs.rs/rate-limits/latest/rate_limits/enum.Vendor.html
[stackoverflow]: https://stackoverflow.com/questions/16022624/examples-of-http-api-rate-limiting-http-response-headers
[headermap]: https://docs.rs/http/latest/http/header/struct.HeaderMap.html
License: Apache-2.0/MIT