Struct StatusLine

pub struct StatusLine<D: Display> { /* private fields */ }

Wraps arbitrary data and displays it periodically on the screen.

Implementations

impl<D: Display + Send + Sync + 'static> StatusLine<D>

pub fn new(data: D) -> StatusLine<D>

Creates a new StatusLine with default options and shows it immediately.

Examples found in repository

examples/progress-bar.rs (line 27)

fn main() {
    let progress = Progress {
        pos: AtomicUsize::new(0),
        max: 1000000000,
    };

    let progress_bar = StatusLine::new(progress);

    // StatusLine can be moved to another thread:
    thread::spawn(move || {
        for _ in 0..progress_bar.max {
            progress_bar.pos.fetch_add(1, Ordering::Relaxed);
        }
    })
    .join()
    .unwrap();
}

pub fn with_options(data: D, options: Options) -> StatusLine<D>

Creates a new StatusLine with custom options.

impl<D: Display> StatusLine<D>

pub fn refresh(&self)

Forces redrawing the status information immediately, without waiting for the next refresh cycle of the background refresh loop.

pub fn set_visible(&self, visible: bool)

Sets the visibility of the status line.

pub fn is_visible(&self) -> bool

Returns true if the status line is currently visible.

Trait Implementations

impl<D: Display> Deref for StatusLine<D>

type Target = D

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<D: Display> Drop for StatusLine<D>

fn drop(&mut self)

Executes the destructor for this type.