Struct MetricWidget 

pub struct MetricWidget { /* private fields */ }

A single metric widget in the dashboard.

Implementations

impl MetricWidget

pub fn counter(label: impl Into<String>, value: i64) -> Self

Creates a counter widget.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::counter("Requests", 42);
assert_eq!(widget.label(), "Requests");
assert_eq!(widget.display_value(), "42");

pub fn gauge(label: impl Into<String>, value: u64, max: u64) -> Self

Creates a gauge widget with a maximum value.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::gauge("CPU %", 75, 100);
assert_eq!(widget.display_value(), "75/100");

pub fn status(label: impl Into<String>, up: bool) -> Self

Creates a status indicator widget.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::status("API", true);
assert_eq!(widget.label(), "API");
assert_eq!(widget.display_value(), "UP");

pub fn text(label: impl Into<String>, text: impl Into<String>) -> Self

Creates a text metric widget.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::text("Version", "1.2.3");
assert_eq!(widget.label(), "Version");
assert_eq!(widget.display_value(), "1.2.3");

pub fn with_max_history(self, max: usize) -> Self

Sets the maximum history length for sparkline display (builder pattern).

Example

use envision::component::MetricWidget;

let widget = MetricWidget::counter("Ops", 0).with_max_history(50);
assert_eq!(widget.history().len(), 0); // no values yet

pub fn label(&self) -> &str

Returns the label.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::counter("Requests", 0);
assert_eq!(widget.label(), "Requests");

pub fn kind(&self) -> &MetricKind

Returns the metric kind.

Example

use envision::component::{MetricWidget, MetricKind};

let widget = MetricWidget::status("DB", false);
assert!(matches!(widget.kind(), MetricKind::Status { up: false }));

pub fn history(&self) -> &[u64]

Returns the sparkline history.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::counter("Ops", 0);
assert!(widget.history().is_empty());

pub fn display_value(&self) -> String

Returns the display value as a string.

Example

use envision::component::MetricWidget;

assert_eq!(MetricWidget::counter("A", 42).display_value(), "42");
assert_eq!(MetricWidget::gauge("B", 75, 100).display_value(), "75/100");
assert_eq!(MetricWidget::status("C", true).display_value(), "UP");
assert_eq!(MetricWidget::status("D", false).display_value(), "DOWN");
assert_eq!(MetricWidget::text("E", "ok").display_value(), "ok");

pub fn set_counter_value(&mut self, value: i64)

Sets the counter value.

Example

use envision::component::MetricWidget;

let mut widget = MetricWidget::counter("Requests", 0);
widget.set_counter_value(100);
assert_eq!(widget.display_value(), "100");

pub fn set_gauge_value(&mut self, value: u64)

Sets the gauge value.

Example

use envision::component::MetricWidget;

let mut widget = MetricWidget::gauge("Memory", 0, 1024);
widget.set_gauge_value(512);
assert_eq!(widget.display_value(), "512/1024");

pub fn set_status(&mut self, up: bool)

Sets the status.

Example

use envision::component::MetricWidget;

let mut widget = MetricWidget::status("API", true);
widget.set_status(false);
assert_eq!(widget.display_value(), "DOWN");

pub fn set_text(&mut self, text: impl Into<String>)

Sets the text value.

Example

use envision::component::MetricWidget;

let mut widget = MetricWidget::text("Version", "1.0");
widget.set_text("2.0");
assert_eq!(widget.display_value(), "2.0");

pub fn increment(&mut self, amount: i64)

Increments a counter by the given amount.

Example

use envision::component::MetricWidget;

let mut widget = MetricWidget::counter("Hits", 10);
widget.increment(5);
assert_eq!(widget.display_value(), "15");

pub fn gauge_percentage(&self) -> Option<f64>

Returns the gauge fill percentage (0.0 to 1.0).

Returns None for non-gauge widgets.

Example

use envision::component::MetricWidget;

let widget = MetricWidget::gauge("CPU", 75, 100);
assert_eq!(widget.gauge_percentage(), Some(0.75));

let counter = MetricWidget::counter("Ops", 10);
assert_eq!(counter.gauge_percentage(), None);

Trait Implementations

impl Clone for MetricWidget

fn clone(&self) -> MetricWidget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricWidget

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricWidget

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetricWidget

fn eq(&self, other: &MetricWidget) -> 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 Serialize for MetricWidget

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricWidget