Skip to main content

LoadingIndicator

Struct LoadingIndicator 

Source
pub struct LoadingIndicator { /* private fields */ }
Expand description

An animated loading indicator widget.

Renders a cycling character animation to indicate progress. Call tick to advance the animation frame.

Implementations§

Source§

impl LoadingIndicator

Source

pub fn new() -> Self

Create a new loading indicator with the default Spinner style.

Source

pub fn with_style(self, style: IndicatorStyle) -> Self

Set the animation style.

Source

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

Set the visual style for the indicator character.

Source

pub fn with_message(self, message: &str) -> Self

Set the message displayed next to the indicator.

Source

pub fn tick(&mut self)

Advance the animation to the next frame.

Source

pub fn reset(&mut self)

Reset the animation to the first frame.

Source

pub fn frame(&self) -> usize

Get the current frame index.

Source

pub fn animation_style(&self) -> IndicatorStyle

Get the current animation style.

Trait Implementations§

Source§

impl Default for LoadingIndicator

Source§

fn default() -> Self

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

impl Widget for LoadingIndicator

Source§

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

Render this widget into the given area of the buffer.

Auto Trait Implementations§

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> 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, 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.