Struct tui::widgets::Gauge

pub struct Gauge<'a> { /* fields omitted */ }

A widget to display a task progress.

Examples:

Gauge::default()
    .block(Block::default().borders(Borders::ALL).title("Progress"))
    .style(Style::default().fg(Color::White).bg(Color::Black).modifier(Modifier::ITALIC))
    .percent(20);

Methods

impl<'a> Gauge<'a>

pub fn block(self, block: Block<'a>) -> Gauge<'a>

pub fn percent(self, percent: u16) -> Gauge<'a>

pub fn ratio(self, ratio: f64) -> Gauge<'a>

Sets ratio ([0.0, 1.0]) directly.

pub fn label(self, string: &'a str) -> Gauge<'a>

pub fn style(self, style: Style) -> Gauge<'a>

Trait Implementations

impl<'a> Widget for Gauge<'a>

fn draw(&mut self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That the only method required to implement a custom widget.

fn background(&self, area: Rect, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, f: &mut Frame<B>, area: Rect) where
    Self: Sized,
    B: Backend, 

Helper method that can be chained with a widget's builder methods to render it.

impl<'a> Default for Gauge<'a>

fn default() -> Gauge<'a>

Returns the "default value" for a type.