Skip to main content

ClassStats

Struct ClassStats 

Source
pub struct ClassStats {
    pub name: String,
    pub bytes_delivered: u64,
    pub bytes_dropped: u64,
    pub objects_delivered: u64,
    pub objects_dropped: u64,
    pub tokens_exhausted_episodes: u64,
    pub blocked_episodes: u64,
    pub starved_behind_other_class: u64,
}
Expand description

Per-class shaping statistics, one entry in ShapeStats.

Every figure is a count, and there is deliberately no duration among them. Two once were — a blocked total and a hold total — and both would have been sums of wall-clock time, movable by the machine’s scheduler as much as by this code, so a gate could only ever have reported them. One of the two would have misdescribed itself as well: Overflow::Block stops this crate calling read() on the source stream and does not stall the peer, because the transport’s own receive window absorbs megabytes before a publisher notices anything — so a blocked time measured here would have been how long this queue refused to read, never how long the publisher was held up, and a test reading it as publisher backpressure would have been measuring the wrong thing under a name that invited it. Real backpressure needs a small TransportProfile::stream_receive_window, which is a transport setting and not a shaping one.

What survives is the load-independent companion a gate can read: Self::blocked_episodes and Self::tokens_exhausted_episodes.

Fields§

§name: String

The ClassRule::name this row reports, or an empty string for the default and unshapeable rows.

§bytes_delivered: u64

Bytes released to the destination stream.

§bytes_dropped: u64

Bytes discarded by a policy.

§objects_delivered: u64

Objects released to the destination stream.

§objects_dropped: u64

Objects discarded by a policy.

§tokens_exhausted_episodes: u64

Edge-triggered: distinct starvation episodes, not dequeue attempts. Level counting would report the runner’s read batching rather than the shaper.

§blocked_episodes: u64

Edge-triggered, same reason: distinct episodes of the read side being stalled by Overflow::Block.

§starved_behind_other_class: u64

Units that waited behind a different class’s unit on the same stream. Separates configured shaping from head-of-line blocking; conflating it with tokens_exhausted_episodes would hide which of the two a scenario actually produced.

Trait Implementations§

Source§

impl Clone for ClassStats

Source§

fn clone(&self) -> ClassStats

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClassStats

Source§

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

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

impl Default for ClassStats

Source§

fn default() -> ClassStats

Returns the “default value” for a type. Read more
Source§

impl Eq for ClassStats

Source§

impl PartialEq for ClassStats

Source§

fn eq(&self, other: &ClassStats) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ClassStats

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more