Struct RetryAfter

pub struct RetryAfter { /* private fields */ }

A monotonic expiration marker for rate limits.

RetryAfter represents a point in time when a rate limit expires. It allows checking whether the rate limit is still active or has expired, and calculating the remaining time until expiration.

Implementations

impl RetryAfter

pub fn from_secs(seconds: u64) -> Self

Creates a new RetryAfter instance that expires after the specified number of seconds.

pub fn remaining_at(self, at: Instant) -> Option<Duration>

Returns the remaining duration until the rate limit expires using the specified instant as the reference point.

If the rate limit has already expired at the given instant, returns None.

pub fn remaining(self) -> Option<Duration>

Returns the remaining duration until the rate limit expires.

This uses the current instant as the reference point. If the rate limit has already expired, returns None.

pub fn remaining_seconds_at(self, at: Instant) -> u64

Returns the remaining seconds until the rate limit expires using the specified instant as the reference point.

This method rounds up to the next second to ensure that rate limits are strictly enforced. If the rate limit has already expired, returns 0.

pub fn remaining_seconds(self) -> u64

Returns the remaining seconds until the rate limit expires.

This uses the current instant as the reference point. If the rate limit has already expired, returns 0.

pub fn expired_at(self, at: Instant) -> bool

Returns whether this rate limit has expired at the specified instant.

pub fn expired(self) -> bool

Returns whether this rate limit has expired at the current instant.

Trait Implementations

impl Clone for RetryAfter

fn clone(&self) -> RetryAfter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetryAfter

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

Formats the value using the given formatter.

impl FromStr for RetryAfter

type Err = InvalidRetryAfter

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RetryAfter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RetryAfter

fn cmp(&self, other: &RetryAfter) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RetryAfter

fn eq(&self, other: &RetryAfter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RetryAfter

fn partial_cmp(&self, other: &RetryAfter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RetryAfter

impl Eq for RetryAfter

impl StructuralPartialEq for RetryAfter