Struct StatsHistory 

pub struct StatsHistory { /* private fields */ }

Ring-buffer history of stat values, polled every snapshot.

The charts read one f64 per series per frame, so that is what a sample costs. A series that a scalar cannot round-trip keeps its full value alongside. An export then carries the same columns that the headless runner writes.

Implementations

impl StatsHistory

pub fn new(descriptors: Vec<StatDescriptor>, capacity: Option<usize>) -> Self

Creates an empty history of descriptors, keeping at most capacity samples, or every sample for None.

pub fn push_entries(&mut self, stats: &[StatEntry], tick: u64)

Records one sample, replacing the newest entry if it has the same tick.

A publish repeats a tick when nothing stepped, as after an action or while a paused layout relaxes. The replacement keeps one entry per tick, holding the latest stats for it.

The first sample fixes which series keep a full value, the same way it fixes a CSV column layout. A series that changes kind later is a model bug, and crate::export::StatsWriter already reports it as a bug.

pub fn descriptors(&self) -> &[StatDescriptor]

Series the history records.

pub fn len(&self) -> usize

Number of entries stored, at most the capacity.

pub fn is_empty(&self) -> bool

Returns whether no sample has been recorded.

pub fn capacity(&self) -> Option<usize>

Maximum number of samples the history keeps, or None while it keeps every sample.

pub fn write_count(&self) -> usize

Total number of writes, including those that wrapped.

pub fn get(&self, col: usize, j: usize) -> Option<(f64, u64)>

Returns the value of series col and its tick at logical index j, where 0 is the oldest visible entry.

pub fn tick(&self, j: usize) -> Option<u64>

Returns the tick at logical index j, where 0 is the oldest visible entry.

pub fn entries(&self, j: usize) -> Option<Vec<StatEntry>>

Returns the sample at logical index j, in the shape that crate::export::StatsWriter accepts.

pub fn heap_bytes(&self) -> usize

Heap memory held by the history, in bytes.

pub fn resize(&mut self, new_capacity: Option<usize>)

Changes the capacity to new_capacity, keeping the most recent entries that fit.

Trait Implementations

impl Debug for StatsHistory

Prints the series labels and the sample counts, not the samples.

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

Formats the value using the given formatter.