Enum StatusItem 

pub enum StatusItem {
    Text(String),
    Hints(usize),
    Spinner {
        name: String,
        text: String,
    },
    Badge {
        text: String,
        style: Style,
    },
    Icon {
        icon: Vec<Segment>,
        text: String,
    },
}

One part of a StatusBar.

Variants

Text(String)

Console markup: [bold]main.rs[/] · 12 lines.

Hints(usize)

Up to this many key hints (ctrl+s save · esc cancel), read from the keymap the bar is given, or the component’s under Overlays.

Spinner

A spinner (one of core’s, by name: dots, line, …) and markup after it. Its frame is picked by the time since the bar was made, as core’s Spinner picks it, and the bar ticks while one shows.

Fields

name: String

text: String

Badge

A short label in a style of its own, padded by a space each side: a mode, a count, a state.

Fields

text: String

style: Style

Icon

An icon, then markup: a micro asset’s badge (✅ deployed). The icon is one line of cells (kit::icon) with its style metadata, so a micro asset’s placeholder is drawn over by the painter’s graphics where the terminal can show images, and shows its emoji or text fallback anywhere else.

Fields

icon: Vec<Segment>

text: String

Implementations

impl StatusItem

pub fn text(markup: impl Into<String>) -> StatusItem

pub fn hints(max: usize) -> StatusItem

pub fn spinner(name: impl Into<String>, markup: impl Into<String>) -> StatusItem

pub fn icon(icon: &Text, markup: impl Into<String>) -> StatusItem

icon (one line of text, such as a micro asset’s placeholder), then markup.

pub fn badge(text: impl Into<String>, style_definition: &str) -> StatusItem

A badge in style, a style definition (bold white on blue); one that does not parse leaves the badge unstyled.

Trait Implementations

impl Clone for StatusItem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusItem

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

Formats the value using the given formatter.

impl PartialEq for StatusItem

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StatusItem