Enum CheckError 

#[non_exhaustive]
pub enum CheckError {
    UnknownTier(String),
    Storage(StorageError),
    #[non_exhaustive]
    CostExceedsLimit {
        cost: u32,
        limit: u32,
    },
}

Error returned by RateTier::check().

Distinguishes between an unknown tier name (a configuration/logic error) and a storage backend failure (e.g., Redis connection lost).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnknownTier(String)

The tier name passed to check() does not exist in the configured tiers.

Storage(StorageError)

The storage backend failed during the rate limit check.

#[non_exhaustive]

CostExceedsLimit

The request costs more than the tier allows in a whole window, so it can never be allowed. Nothing was consumed.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cost: u32

The cost of the rejected request.

limit: u32

The tier’s maximum burst.

Trait Implementations

impl Debug for CheckError

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

Formats the value using the given formatter.

impl Display for CheckError

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

Formats the value using the given formatter.

impl Error for CheckError

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 From<StorageError> for CheckError

fn from(err: StorageError) -> Self

Converts to this type from the input type.