Skip to main content

IndeterminateSpinner

Struct IndeterminateSpinner 

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

A spinner for operations with unknown total count or duration.

Shows activity with elapsed time, useful for:

  • Establishing database connections
  • Running complex queries
  • Waiting for locks
  • Initial data discovery

§Rendering Modes

  • Rich mode: Animated spinner with message and elapsed time
  • Plain mode: Static [...] message (elapsed) format for agents
  • JSON mode: Structured data for programmatic consumption

§Example

use sqlmodel_console::renderables::{IndeterminateSpinner, SpinnerStyle};

let spinner = IndeterminateSpinner::new("Loading data")
    .style(SpinnerStyle::Braille);

// Can convert to progress bar when total becomes known
let progress = spinner.into_progress(1000);

Implementations§

Source§

impl IndeterminateSpinner

Source

pub fn new(message: impl Into<String>) -> Self

Create a new spinner with a message.

§Arguments
  • message: Status message describing the operation
Source

pub fn style(self, style: SpinnerStyle) -> Self

Set the animation style.

Source

pub fn theme(self, theme: Theme) -> Self

Set the theme for styled output.

Source

pub fn set_message(&mut self, message: impl Into<String>)

Update the status message.

Source

pub fn message(&self) -> &str

Get the current message.

Source

pub fn current_style(&self) -> SpinnerStyle

Get the current style.

Source

pub fn reset_timer(&mut self)

Reset the start time.

Source

pub fn elapsed_secs(&self) -> f64

Get elapsed time in seconds.

Source

pub fn elapsed_ms(&self) -> u64

Get elapsed time in milliseconds.

Source

pub fn current_frame(&self) -> &'static str

Get the current animation frame.

Source

pub fn into_progress(self, total: u64) -> OperationProgress

Convert to a progress bar when total becomes known.

The progress bar inherits the spinner’s message as the operation name and starts with 0 completed items.

§Arguments
  • total: The total number of items to process
Source

pub fn render_plain(&self) -> String

Render as plain text for agents.

Format: [...] message (elapsed)

Source

pub fn render_styled(&self) -> String

Render with ANSI styling and animation.

Shows the current animation frame with colors.

Source

pub fn to_json(&self) -> String

Render as JSON for structured output.

Trait Implementations§

Source§

impl Clone for IndeterminateSpinner

Source§

fn clone(&self) -> IndeterminateSpinner

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 IndeterminateSpinner

Source§

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

Formats the value using the given formatter. 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, 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.