Struct RateLimit 

#[non_exhaustive]
pub struct RateLimit {
    pub limit: u32,
    pub remaining: u32,
    pub retry_after: MangaDexDateTime,
}

This RateLimit struct contains all the data needed for rate limit handling It can be parsed via a reqwest::Response or reqwest::header::HeaderMap

    use mangadex_api_types_rust::rate_limit::{LIMIT, REMAINING, RETRY_AFTER, RateLimit, RateLimitParseError};
    use reqwest::header::{HeaderMap, HeaderValue};

    fn main() -> Result<(), RateLimitParseError> {
        let mut headers = HeaderMap::new();
        headers.append(RETRY_AFTER, HeaderValue::from_static("1698723860"));
        headers.append(LIMIT, HeaderValue::from_static("40"));
        headers.append(REMAINING, HeaderValue::from_static("39"));
        assert_eq!(headers.len(), 3);
        let rate_limit: RateLimit = TryFrom::try_from(&headers)?;
        assert_eq!(rate_limit.limit, 40);
        assert_eq!(rate_limit.remaining, 39);
        Ok(())
    }

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

limit: u32

value from x-ratelimit-limit header

remaining: u32

value from x-ratelimit-remaining header

retry_after: MangaDexDateTime

value from x-ratelimit-retry-after header It’s normally an i64 (Unix timestamp) but can be parsed as a [crate::MangaDexDateTime]

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl Default for RateLimit

fn default() -> RateLimit

Returns the “default value” for a type.

impl Serialize for RateLimit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&HeaderMap> for RateLimit

type Error = RateLimitParseError

The type returned in the event of a conversion error.

fn try_from(value: &HeaderMap) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Response> for RateLimit

type Error = RateLimitParseError

The type returned in the event of a conversion error.

fn try_from(value: &Response) -> Result<Self, Self::Error>

Performs the conversion.