Skip to main content

Spinner

Struct Spinner 

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

Spinner component for displaying loading animations

The spinner consists of:

  • A rotating character animation
  • A label displayed next to the spinner

Implementations§

Source§

impl Spinner

Source

pub fn new(label: &str) -> Self

Create a new spinner with a given label

§Arguments
  • label - The text to display next to the spinner
§Returns

A new Spinner instance ready for animation

§Example
use limit_tui::components::Spinner;

let spinner = Spinner::new("Loading...");
Source

pub fn with_frames(label: &str, frames: Vec<String>) -> Self

Create a new spinner with custom frames Create a new spinner with custom frames

§Arguments
  • label - The text to display next to the spinner
  • frames - Vector of animation frames
§Returns

A new Spinner instance with custom animation frames

Source

pub fn tick(&mut self)

Advance the spinner to the next frame

Call this method at your desired frame rate. For a smooth 10 FPS animation, call tick() every 100ms.

§Example
use limit_tui::components::Spinner;
use std::thread;
use std::time::Duration;

let mut spinner = Spinner::new("Loading...");
loop {
    spinner.tick();
    // render spinner
    thread::sleep(Duration::from_millis(100)); // 10 FPS
}
Source

pub fn current_frame(&self) -> &str

Get the current animation frame

§Returns

The current spinner character

Source

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

Render the spinner to a buffer

§Arguments
  • area - The area to render the spinner in
  • buf - The buffer to render to

Trait Implementations§

Source§

impl Clone for Spinner

Source§

fn clone(&self) -> Spinner

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 Debug for Spinner

Source§

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

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

impl Default for Spinner

Source§

fn default() -> Self

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

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> 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more