Enum RateLimitError

pub enum RateLimitError {
    ExceedsCapacity,
    ContentionFailure,
    ExpiredTick,
}

Error types for rate limiter operations.

These errors indicate different failure modes when attempting to acquire tokens from a rate limiter.

Variants

ExceedsCapacity

Request exceeds available capacity.

This indicates that allowing the request would violate the rate limit. The caller should either:

• Reject the request
• Wait and retry later
• Reduce the number of tokens requested

ContentionFailure

Failed due to contention with other threads.

This occurs when the internal lock cannot be acquired immediately. The caller should typically:

• Retry the operation
• Implement backoff strategy
• Consider the request as temporarily failed

ExpiredTick

The provided tick is too old or regressed.

This occurs when:

• Time appears to go backwards
• An older tick is reused
• System clock adjustments occur

Trait Implementations

impl Clone for RateLimitError

fn clone(&self) -> RateLimitError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitError

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

Formats the value using the given formatter.

impl Display for RateLimitError

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

Formats the value using the given formatter.

impl Error for RateLimitError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for RateLimitError

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

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

const 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 Copy for RateLimitError

impl Eq for RateLimitError

impl StructuralPartialEq for RateLimitError