Enum RateLimiterError 

#[non_exhaustive]
pub enum RateLimiterError {
    ZeroQuota,
    ZeroPeriod,
}

A limit configuration rejected at construction time.

Returned by Quota::rate when the supplied values cannot describe a working rate limit. Each variant names exactly which constraint was violated so the caller can correct the specific field.

The enum is #[non_exhaustive]: future releases may add validation rules (and therefore variants) without it being a breaking change, so a match on it must include a wildcard arm.

Examples

use rate_net::{Quota, RateLimiterError};
use std::time::Duration;

let err = Quota::rate(0, Duration::from_secs(1)).unwrap_err();
assert_eq!(err, RateLimiterError::ZeroQuota);

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.

ZeroQuota

The quota limit was zero. A limit that admits nothing per period can never allow a request; supply a limit of at least 1.

ZeroPeriod

The quota period was zero. The limit accrues per period, so a zero-length period is undefined (it implies an infinite rate); supply a non-zero Duration.

Trait Implementations

impl Clone for RateLimiterError

fn clone(&self) -> RateLimiterError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimiterError

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

Formats the value using the given formatter.

impl Display for RateLimiterError

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

Formats the value using the given formatter.

impl Error for RateLimiterError

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 ForgeError for RateLimiterError

fn kind(&self) -> &'static str

Returns the kind of error, typically matching the enum variant

fn caption(&self) -> &'static str

Returns a human-readable caption for the error

fn is_retryable(&self) -> bool

Returns true if the operation can be retried

fn is_fatal(&self) -> bool

Returns true if the error is fatal and should terminate the program

fn status_code(&self) -> u16

Returns an appropriate HTTP status code for the error

fn exit_code(&self) -> i32

Returns an appropriate process exit code for the error

fn user_message(&self) -> String

Returns a user-facing message that can be shown to end users

fn dev_message(&self) -> String

Returns a detailed technical message for developers/logs

fn backtrace(&self) -> Option<&Backtrace>

Returns a backtrace if available

fn register(&self)

Registers the error with the central error registry

impl PartialEq for RateLimiterError

fn eq(&self, other: &RateLimiterError) -> 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 Copy for RateLimiterError

impl Eq for RateLimiterError

impl StructuralPartialEq for RateLimiterError