Struct Options

pub struct Options {
    pub refresh_period: Duration,
    pub initially_visible: bool,
    pub enable_ansi_escapes: bool,
}

Options controlling how to display the status line

Fields

refresh_period: Duration

How long to wait between subsequent refreshes of the status. Defaults to 100 ms on interactive terminals (TTYs) and 1 s if the standard error is not interactive, e.g. redirected to a file.

initially_visible: bool

Set it to false if you don’t want to show the status on creation of the StatusLine. You can change the visibility of the StatusLine any time by calling StatusLine::set_visible.

enable_ansi_escapes: bool

Set to true to enable ANSI escape codes. By default set to true if the standard error is a TTY. If ANSI escape codes are disabled, the status line is not erased before each refresh, it is printed in a new line instead.

Trait Implementations

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.