ScaleLadder

Enum ScaleLadder 

Source
pub enum ScaleLadder {
    Ns,
    Us,
    Bytes,
    Ticks,
    Unitless,
    None,
}
Expand description

Closed enumeration of auto-scale ladders driving format dispatch.

Picks the unit family up the type system rather than a free-form &'static str tag. Each AggRule variant maps to exactly one ladder via AggRule::ladder; each super::DerivedMetricDef entry carries a ladder via super::DerivedMetricDef::ladder; the cgroup- level render path passes a ladder directly. A registry typo or drift between accessor newtype and ladder choice fails to compile at the registry edit site rather than silently routing through an “unknown unit” pass-through arm at render time.

The six ladder variants and their step-up rules:

  • Ns: ns → µs (×1e3) → ms (×1e6) → s (×1e9). Decimal prefixes — SI time, not binary. Used for AggRule::SumNs (cumulative ns counters), AggRule::MaxPeak (lifetime ns high-water marks), AggRule::MaxGaugeNs (instantaneous ns gauges), and the "ns" derived-metric ladder.
  • Us: µs → ms (×1e3) → s (×1e6). Decimal SI prefixes. The cgroup cpu_usage_usec and throttled_usec fields are reported by the kernel in microseconds; this ladder scales them up the same way the Ns ladder scales nanoseconds.
  • Bytes: B → KiB → MiB → GiB → TiB. IEC binary prefixes (×1024) for byte counts. Used for AggRule::SumBytes, AggRule::MaxPeakBytes, and any byte-typed derived metric.
  • Ticks: ticks → Kticks (×1e3) → Mticks (×1e6). Decimal prefixes for clock-tick counts (utime_clock_ticks, stime_clock_ticks); the unit itself is opaque (the kernel’s USER_HZ rate is host-dependent), so an SI prefix is the most we can promise.
  • Unitless: “” → K → M → G. Decimal prefixes for non-dimensional counters (wakeups, migrations, csw, syscall counts). Used for AggRule::SumCount and AggRule::MaxGaugeCount.
  • None: no ladder — values render as the bare integer with no unit suffix and no scaling. Used for AggRule::Mode / AggRule::ModeChar / AggRule::ModeBool (categorical strings), AggRule::RangeI32 / AggRule::RangeU32 (bounded ordinals), and AggRule::Affinity (cpuset summaries) — the Aggregated std::fmt::Display impl handles render for these directly.

The threshold for stepping up is |value| >= next_scale. Sign is preserved through scaling (negative deltas pass through). Zero stays at base unit.

Variants§

§

Ns

§

Us

§

Bytes

§

Ticks

§

Unitless

§

None

Implementations§

Source§

impl ScaleLadder

Source

pub fn base_unit(&self) -> &'static str

Base unit string for this ladder — what auto_scale returns for a value at the bottom of the ladder. Used by the format helpers to detect whether a value stepped up (auto_scale(v).1 != ladder.base_unit() ⇒ stepped up, render with the scaled unit; equal ⇒ no step-up, render the bare integer with the base unit suffix).

Trait Implementations§

Source§

impl Clone for ScaleLadder

Source§

fn clone(&self) -> ScaleLadder

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 ScaleLadder

Source§

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

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

impl Hash for ScaleLadder

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ScaleLadder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for ScaleLadder

Source§

impl Eq for ScaleLadder

Source§

impl StructuralPartialEq for ScaleLadder

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,