Skip to main content

QuotaViolationError

Struct QuotaViolationError 

Source
pub struct QuotaViolationError { /* private fields */ }
Expand description

Raised when a sensor records a value that takes a metric outside the bounds configured as its quota.

Corresponds to Java’s QuotaViolationException. It has no entry in Errors, so it carries no protocol code.

Java extends chain: QuotaViolationException -> KafkaException

Hand-written rather than declared with kafka_error_type! because it adds subclass state (the metric, the recorded value and the bound) and overrides toString() instead of taking the generated "<TypeName>: <message>" form.

Two deliberate deviations from the Java class:

  • Java holds the KafkaMetric itself and exposes it as metric(). This holds the metric’s MetricName, because KafkaMetric owns a Box<dyn Measurable> and so is neither Clone nor Debug — both of which Error requires. Nothing is lost for a client: Java’s own toString() uses only metric.metricName(), and the client has no caller of metric() (the broker’s ClientQuotaManager is the only one in the Kafka tree).
  • Java overrides fillInStackTrace() to skip capturing a stack trace, since quota violations are frequent and the trace is never read. Rust errors do not capture one at all, so there is nothing to suppress.

Implementations§

Source§

impl QuotaViolationError

Source

pub fn new(metric_name: MetricName, value: f64, bound: f64) -> Self

Create the error, mirroring Java’s QuotaViolationException(KafkaMetric metric, double value, double bound).

Source

pub fn metric_name(&self) -> &MetricName

The name of the metric that violated its quota.

Stands in for Java’s metric() — see the type-level note.

Source

pub fn value(&self) -> f64

The value that was recorded. Mirrors Java’s value().

Source

pub fn bound(&self) -> f64

The quota bound that was crossed. Mirrors Java’s bound().

Source

pub fn source(&self) -> Option<&Error>

The underlying cause, if any. Mirrors Java’s getCause().

Trait Implementations§

Source§

impl Clone for QuotaViolationError

Source§

fn clone(&self) -> QuotaViolationError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QuotaViolationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for QuotaViolationError

Source§

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

Java’s toString() override: getClass().getName() + ": '" + metric.metricName() + "' violated quota. Actual: " + value + ", Threshold: " + bound.

Source§

impl Error for QuotaViolationError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

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

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

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V