Struct StatusBar 

pub struct StatusBar<M = ()> { /* private fields */ }

A status line (#481): StatusItems on the left and on the right, separated by │. It takes no focus and uses no events but ticks, so it sits under anything in a container, or under any component with Overlays::status_bar, which also feeds its hints the component’s keymap. Change it while it shows through its handle.

Implementations

impl<M> StatusBar<M>

pub fn new() -> StatusBar<M>

pub fn left(self, id: &str, item: StatusItem) -> Self

Add item as id on the left.

pub fn right(self, id: &str, item: StatusItem) -> Self

Add item as id on the right.

pub fn keymap(self, keymap: Keymap) -> Self

The keymap hints read (see StatusHandle::set_keymap).

pub fn style(self, style: Style) -> Self

The style of the whole line, padded to the width (default: none; on grey23 for a bar with a background).

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

What goes between items (default │).

pub fn theme(self, theme: Theme) -> Self

pub fn clock(self, clock: impl Fn() -> Duration + 'static) -> Self

Where spinners read the time from (default: the time since the bar was made): a fixed clock makes a test’s frames exact.

pub fn animate(self, on: bool) -> Self

Whether spinners turn (default: unless RICH_ANIMATION=0, or RICH_A11Y asks for reduced motion, no animation or a screen reader, as for every other animation). Off, a spinner shows its first frame and the bar never ticks.

pub fn handle(&self) -> StatusHandle

A handle that changes this bar’s items while it shows.

pub fn line( &self, context: &Context<'_>, keymap: Option<&Keymap>, ) -> Vec<Segment>

The line at context’s width, with hints read from keymap when given, else from the bar’s own.

pub fn line_text(&self, width: usize) -> String

The line at width, as plain text, for tests and logs.

Trait Implementations

impl<M> Component for StatusBar<M>

type Output = M

fn handle(&mut self, event: &Event, _: &Context<'_>) -> Flow<M>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn start(&mut self, context: &Context<'_>) -> Flow<Self::Output>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.

fn default_value(&self) -> Option<Self::Output>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<Self::Output>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

impl<M> Default for StatusBar<M>

fn default() -> Self

Returns the “default value” for a type.