Struct StatColumns 

pub struct StatColumns { /* private fields */ }

Column layout of a stat series, planned from one sample.

A scalar series is one column, a vector is three (.x, .y and .magnitude), and a histogram is one per bucket plus .total.

Implementations

impl StatColumns

pub fn plan(stats: &[StatEntry]) -> Self

Derives the column layout from the sample stats.

pub fn len(&self) -> usize

Number of columns.

pub fn is_empty(&self) -> bool

Returns whether the layout has no columns.

pub fn name(&self, i: usize) -> &str

Returns the name of column i, before CSV escaping.

Panics

Panics when i is not below Self::len.

pub fn header(&self, i: usize) -> &str

Returns the header of column i, escaped for CSV.

Panics

Panics when i is not below Self::len.

pub fn is_bucket(&self, i: usize) -> bool

Returns whether column i counts a single histogram bucket.

Panics

Panics when i is not below Self::len.

pub fn resolve(&self, name: &str) -> Option<usize>

Returns the index of the column called name.

A bare vector or histogram label resolves to its magnitude or total column, the value StatValue::scalar returns. An exact column name wins over a bare label.

pub fn extract( &self, tick: u64, stats: &[StatEntry], out: &mut Vec<f64>, ) -> Result<(), StatsWriteError>

Replaces the contents of out with one value per column, read from the sample stats taken at tick.

Errors

Returns StatsWriteError::Shape when stats no longer fits the planned layout.

Trait Implementations

impl Clone for StatColumns

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatColumns

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

Formats the value using the given formatter.

impl Eq for StatColumns

impl PartialEq for StatColumns

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StatColumns