Gauge

Struct Gauge 

Source
pub struct Gauge<'a> { /* private fields */ }
Expand description

A widget to display a task progress.

§Examples:

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

Implementations§

Source§

impl<'a> Gauge<'a>

Source

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

Source

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

Source

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

Sets ratio ([0.0, 1.0]) directly.

Source

pub fn label<T>(self, label: T) -> Gauge<'a>
where T: Into<Span<'a>>,

Source

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

Source

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

Source

pub fn use_unicode(self, unicode: bool) -> Gauge<'a>

Trait Implementations§

Source§

impl<'a> Clone for Gauge<'a>

Source§

fn clone(&self) -> Gauge<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Gauge<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> Gauge<'a>

Returns the “default value” for a type. Read more
Source§

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

Source§

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

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

Auto Trait Implementations§

§

impl<'a> Freeze for Gauge<'a>

§

impl<'a> RefUnwindSafe for Gauge<'a>

§

impl<'a> Send for Gauge<'a>

§

impl<'a> Sync for Gauge<'a>

§

impl<'a> Unpin for Gauge<'a>

§

impl<'a> UnwindSafe for Gauge<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.