Struct Statistics 

pub struct Statistics { /* private fields */ }

Runtime statistics.

Implementations

impl Statistics

constructors & deconstructors

pub fn new(nc: &Notcurses) -> Self

Allocates a Statistics object.

pub fn into_ref(&self) -> &NcStats

Returns a shared reference to the inner NcStats.

pub fn into_ref_mut(&mut self) -> &mut NcStats

Returns an exclusive reference to the inner NcStats.

impl Statistics

manager methods

pub fn update(&mut self, nc: &Notcurses)

Acquires an atomic snapshot of the notcurses object’s stats.

pub fn reset(&mut self, nc: &Notcurses)

Resets all cumulative stats.

Immediate ones, such as fbbytes, are not reset.

impl Statistics

query methods

pub fn renders(&self) -> u64

Successful renders.

pub fn failed_renders(&self) -> u64

Failed renders.

pub fn render_ns(&self) -> u64

Nanoseconds spent rendering.

pub fn render_max_ns(&self) -> i64

Max ns spent in render for a frame.

pub fn render_min_ns(&self) -> i64

Min ns spent in render for a frame.

pub fn writeouts(&self) -> u64

Successful rasterizations.

pub fn failed_writeouts(&self) -> u64

Failed rasterizations.

pub fn raster_bytes(&self) -> u64

Bytes emitted to ttyfp.

pub fn raster_max_bytes(&self) -> i64

Max bytes emitted for a frame.

pub fn raster_min_bytes(&self) -> i64

Min bytes emitted for a frame.

pub fn raster_ns(&self) -> u64

Nanoseconds spent rasterizing.

pub fn raster_max_ns(&self) -> i64

Max ns spent in raster for a frame.

pub fn raster_min_ns(&self) -> i64

Min ns spent in raster for a frame.

pub fn cell_elisions(&self) -> u64

Cells we elided entirely thanks to damage maps.

pub fn cell_emissions(&self) -> u64

Total number of cells emitted to terminal.

pub fn fg_elisions(&self) -> u64

RGB fg elision count.

pub fn fg_emissions(&self) -> u64

RGB fg emissions.

pub fn bg_elisions(&self) -> u64

RGB bg elision count.

pub fn bg_emissions(&self) -> u64

RGB bg emissions.

pub fn default_elisions(&self) -> u64

Default color was emitted.

pub fn default_emissions(&self) -> u64

Default color was elided.

pub fn sprixel_emissions(&self) -> u64

Sprixel draw count.

pub fn sprixel_elisions(&self) -> u64

Sprixel elision count.

pub fn sprixel_bytes(&self) -> u64

Sprixel bytes emitted.

pub fn refreshes(&self) -> u64

Refresh requests (non-optimized redraw).

pub fn appsync_updates(&self) -> u64

How many application-synchronized updates?

pub fn input_errors(&self) -> u64

Errors processing control sequences/utf8.

pub fn input_events(&self) -> u64

Characters returned to userspace.

pub fn hpa_gratuitous(&self) -> u64

Unnecessary hpas issued.

The number of hpa (horizontal position absolute, see terminfo(5)) control sequences issued where not strictly necessary.

This is done to cope with fundamental ambiguities regarding glyph width. It is not generally possible to know how wide a glyph will be rendered on a given combination of font, font rendering engine, and terminal. Indeed, it is not even generally possible to know how many glyphs will result from a sequence of EGCs. As a result, Notcurses sometimes issues “gratuitous” hpa controls.

pub fn cell_geo_changes(&self) -> u64

Cell geometry changes (resizes).

The number of changes to the visible area’s cell geometry.

The cell geometry changes whenever the visible area is resized without a corresponding cell-pixel geometry change.

Both can change at the same time if e.g. a terminal undergoes a font size change without changing its total size.

pub fn pixel_geo_changes(&self) -> u64

Pixel geometry changes (font resize).

The number of changes to cells’ pixel geometry (i.e. the height and width of each cell), and changes whenever the font size changes.

pub fn fb_bytes(&self) -> u64

Total bytes devoted to all active framebuffers.

pub fn planes(&self) -> u32

Number of planes currently in existence.

Trait Implementations

impl Clone for Statistics

fn clone(&self) -> Statistics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Statistics

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

Formats the value using the given formatter.

impl Drop for Statistics

fn drop(&mut self)

Executes the destructor for this type.

impl From<&mut ncstats> for Statistics

fn from(nc: &mut NcStats) -> Statistics

Converts to this type from the input type.

impl PartialEq for Statistics

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Statistics

impl StructuralPartialEq for Statistics