Enum RateLimitError 

pub enum RateLimitError {
    InsufficientCapacity {
        acquiring: Uint,
        available: Uint,
        retry_after: Duration,
    },
    BeyondCapacity {
        acquiring: Uint,
        capacity: Uint,
    },
    ExpiredTick {
        min_acceptable_tick: Uint,
    },
    ContentionFailure,
}

Verbose error type with detailed diagnostic information and Duration-based retry timing.

This error type provides comprehensive information about rate limiting failures, including current state and retry timing information. The retry timing is provided as a standard Duration for easy integration with async ecosystems.

Variants

InsufficientCapacity

Not enough tokens available to fulfill the request.

Fields

acquiring: Uint

Number of tokens requested in the failed operation.

available: Uint

Number of tokens currently available in the rate limiter.

retry_after: Duration

Duration to wait before retrying the operation.

BeyondCapacity

The requested number of tokens exceeds the maximum capacity.

Fields

acquiring: Uint

Number of tokens requested in the failed operation.

capacity: Uint

Maximum capacity of the rate limiter.

ExpiredTick

The provided tick is older than the acceptable minimum.

Fields

min_acceptable_tick: Uint

Minimum acceptable tick value for the rate limiter.

ContentionFailure

Failed to acquire the internal lock due to contention.

Implementations

impl RateLimitError

pub fn from_core_error<F>( error: VerboseRateLimitError, tick_to_duration: F, ) -> Self

where F: FnOnce(Uint) -> Duration,

Creates a RateLimitError from a core verbose error.

This method converts core verbose errors to high-level errors, with tick-to-Duration conversion using the provided converter function.

Trait Implementations

impl Clone for RateLimitError

fn clone(&self) -> RateLimitError

Returns a duplicate of the value.

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 ==.

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 Eq for RateLimitError

impl StructuralPartialEq for RateLimitError