Struct UsageMetric 

pub struct UsageMetric { /* private fields */ }

A single usage metric entry.

Represents a label-value pair with optional color and icon.

Example

use envision::component::UsageMetric;
use ratatui::style::Color;

let metric = UsageMetric::new("CPU", "45%")
    .with_color(Color::Green)
    .with_icon("*");

assert_eq!(metric.label(), "CPU");
assert_eq!(metric.value(), "45%");
assert_eq!(metric.color(), Some(Color::Green));
assert_eq!(metric.icon(), Some("*"));

Implementations

impl UsageMetric

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

Creates a new usage metric with a label and value.

Example

use envision::component::UsageMetric;

let metric = UsageMetric::new("CPU", "45%");
assert_eq!(metric.label(), "CPU");
assert_eq!(metric.value(), "45%");
assert_eq!(metric.color(), None);
assert_eq!(metric.icon(), None);

pub fn with_color(self, color: Color) -> Self

Sets the color for the metric value.

Example

use envision::component::UsageMetric;
use ratatui::style::Color;

let metric = UsageMetric::new("CPU", "45%").with_color(Color::Green);
assert_eq!(metric.color(), Some(Color::Green));

pub fn with_icon(self, icon: impl Into<String>) -> Self

Sets the icon prefix for the metric.

Example

use envision::component::UsageMetric;

let metric = UsageMetric::new("CPU", "45%").with_icon("*");
assert_eq!(metric.icon(), Some("*"));

pub fn label(&self) -> &str

Returns the metric label.

pub fn value(&self) -> &str

Returns the metric value.

pub fn color(&self) -> Option<Color>

Returns the optional color.

pub fn icon(&self) -> Option<&str>

Returns the optional icon.

pub fn set_label(&mut self, label: impl Into<String>)

Sets the metric label.

Example

use envision::component::UsageMetric;

let mut metric = UsageMetric::new("CPU", "45%");
metric.set_label("Processor");
assert_eq!(metric.label(), "Processor");

pub fn set_value(&mut self, value: impl Into<String>)

Sets the metric value.

Example

use envision::component::UsageMetric;

let mut metric = UsageMetric::new("CPU", "45%");
metric.set_value("80%");
assert_eq!(metric.value(), "80%");

pub fn set_color(&mut self, color: Option<Color>)

Sets the optional color.

Example

use envision::component::UsageMetric;
use ratatui::style::Color;

let mut metric = UsageMetric::new("CPU", "45%");
metric.set_color(Some(Color::Red));
assert_eq!(metric.color(), Some(Color::Red));

pub fn set_icon(&mut self, icon: Option<String>)

Sets the optional icon.

Example

use envision::component::UsageMetric;

let mut metric = UsageMetric::new("CPU", "45%");
metric.set_icon(Some("*".to_string()));
assert_eq!(metric.icon(), Some("*"));

Trait Implementations

impl Clone for UsageMetric

fn clone(&self) -> UsageMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UsageMetric

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UsageMetric

impl StructuralPartialEq for UsageMetric