Enum DiskThrottleValidationError 

pub enum DiskThrottleValidationError {
    BurstBelowRate {
        dimension: ThrottleDimension,
        burst: u64,
        rate: u64,
    },
    BurstWithoutRate {
        dimension: ThrottleDimension,
    },
}

Validation failure for DiskThrottle::validate.

Returned by DiskThrottle::validate when a throttle/burst chain violates the constraints documented on DiskThrottle. The Display impl carries the same actionable text the previous String-returning shape did (with the “, or pass 0 to clear …” remediation hint preserved) so callers that bubble the error through anyhow::Error and match on the rendered message keep working.

Tests that need to assert on a specific failure variant downcast via err.downcast_ref::<DiskThrottleValidationError>() (when the error is wrapped in anyhow) or pattern-match the enum directly. The dimension() accessor exposes which dimension (iops/bytes) tripped the rule for callers that route programmatic recovery (e.g. clear the offending *_burst_capacity and retry).

Variants

BurstBelowRate

*_burst_capacity is set to a value strictly below the corresponding * refill rate. A bucket with capacity below its refill rate cannot hold a full second of refilled tokens, so the effective steady-state rate would silently be the capacity, not the configured rate.

Fields

dimension: ThrottleDimension

Throttle dimension this failure applies to.

burst: u64

The offending burst-capacity value.

rate: u64

The refill rate the burst was compared against.

BurstWithoutRate

*_burst_capacity is set with no matching * refill rate. A bucket with no refill rate is a functionally unbounded one-shot capacity, which does not match any useful throttling model.

Fields

dimension: ThrottleDimension

Throttle dimension this failure applies to.

Implementations

impl DiskThrottleValidationError

pub fn dimension(&self) -> ThrottleDimension

Throttle dimension (iops/bytes) the failure applies to. Lets callers route a programmatic recovery without parsing the rendered message — e.g. “clear the offending burst override and re-validate” can dispatch on this without string-matching iops_burst_capacity vs bytes_burst_capacity.

Trait Implementations

impl Clone for DiskThrottleValidationError

fn clone(&self) -> DiskThrottleValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiskThrottleValidationError

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

Formats the value using the given formatter.

impl Display for DiskThrottleValidationError

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

Formats the value using the given formatter.

impl Error for DiskThrottleValidationError

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 Hash for DiskThrottleValidationError

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 PartialEq for DiskThrottleValidationError

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

impl StructuralPartialEq for DiskThrottleValidationError