Struct Gauge 

pub struct Gauge { /* private fields */ }

A one-row meter for a value in a range: label, meter and value.

The meter fills in eighths of a cell (whole cells in ASCII mode). With thresholds the fill takes the success, warning or danger tone by value, the parts of the track past each threshold are tinted faintly so the limits are visible before they are reached, and the value carries a marker so the state reads without colour. The value shows a percentage of the range unless a text is given. When the area is too narrow for a meter, only the label and value remain.

A gauge is a readout, not a control: its one value is always written beside the meter, so there is nothing a pointer or a key could move to. It takes no keyboard focus and answers no input. To let someone set the value, use a Slider; to explain a label that had to be cut, wrap the gauge in a Tooltip; to read a value out of a history, use a Sparkline.

Style keys: gauge and gauge.<success|warning|danger> (track, fill, zone for the tint past a threshold), gauge-label (fg), gauge-value and gauge-value.<level> (fg, bold).

Implementations

impl Gauge

pub fn new(value: f32) -> Self

A gauge at value in the range 0 to 100.

pub fn range(self, min: f32, max: f32) -> Self

The range the value lives in, e.g. 0.0, 64.0 for gibibytes of memory.

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

A name drawn before the meter, e.g. “Memory”.

pub fn label_width(self, cells: u16) -> Self

Reserves cells for the label, so gauges stacked with different labels line up. Longer labels are cut with ….

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

Text drawn after the meter instead of the percentage, e.g. “6.2 of 8 GiB”.

pub fn thresholds(self, warning: f32, danger: f32) -> Self

From warning the gauge turns to the warning tone, from danger to the danger tone; below both it is in the success tone. Values are in the gauge’s range.

Trait Implementations

impl Clone for Gauge

fn clone(&self) -> Gauge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gauge

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

Formats the value using the given formatter.

impl PartialEq for Gauge

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Gauge

impl<Msg: 'static> Widget<Msg> for Gauge

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn event(&self, _cx: &mut EventCx<'_, Msg>, _event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.