Struct CircleSpinner 

pub struct CircleSpinner<'a> { /* private fields */ }

A spinner whose arc rotates clockwise around a circular braille-dot ring.

Uses a 1:1 dot pitch which, after braille packing (2 dot-cols per char-col, 4 dot-rows per char-row) and the ~2× terminal cell aspect ratio, produces a visually round circle.

There is no centre fill — only the rotating arc on the ring is drawn.

Layout

The rendered size in terminal characters is approximately:

• columns: ⌈(2r + 1) / 2⌉
• rows: ⌈(2r + 1) / 4⌉

Use CircleSpinner::char_size to query the exact dimensions.

Examples

use ratatui::style::Color;
use ratatui::Frame;
use ratatui::layout::Rect;
use tui_spinner::CircleSpinner;

fn draw(frame: &mut Frame, area: Rect, tick: u64) {
    frame.render_widget(
        CircleSpinner::new(tick)
            .radius(6)
            .arc_color(Color::Cyan)
            .dim_color(Color::DarkGray),
        area,
    );
}

Implementations

impl<'a> CircleSpinner<'a>

pub fn new(tick: u64) -> Self

Creates a new CircleSpinner with defaults: radius 4, clockwise spin, white arc, dark-gray dim ring, 1 tick per step, auto arc length.

Examples

use tui_spinner::CircleSpinner;

let spinner = CircleSpinner::new(42);

pub fn radius(self, r: usize) -> Self

Sets the circle radius in braille dots (default: 4, minimum: 1).

Examples

use tui_spinner::CircleSpinner;

let big = CircleSpinner::new(0).radius(8);

pub fn arc_len(self, len: usize) -> Self

Sets the number of perimeter dots in the bright arc (0 = auto ¼ of the total perimeter length).

pub const fn spin(self, spin: Spin) -> Self

Sets the spin direction (default: Spin::Clockwise).

Examples

use tui_spinner::{CircleSpinner, Spin};

let ccw = CircleSpinner::new(0).spin(Spin::CounterClockwise);

pub fn ticks_per_step(self, n: u64) -> Self

Sets how many ticks each arc step is held (default: 1, higher = slower).

pub const fn arc_color(self, color: Color) -> Self

Sets the colour of the rotating bright arc (default: Color::White).

Examples

use ratatui::style::Color;
use tui_spinner::CircleSpinner;

let spinner = CircleSpinner::new(0).arc_color(Color::Cyan);

pub const fn dim_color(self, color: Color) -> Self

Sets the colour of the dim background ring (default: Color::DarkGray).

Examples

use ratatui::style::Color;
use tui_spinner::CircleSpinner;

let spinner = CircleSpinner::new(0).dim_color(Color::DarkGray);

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

Wraps the spinner in a Block.

pub fn style<S: Into<Style>>(self, style: S) -> Self

Sets the base style for the widget area.

pub const fn alignment(self, alignment: Alignment) -> Self

Sets the horizontal alignment of the rendered output (default: left).

pub fn char_size(&self) -> (u16, u16)

Returns the exact rendered size in terminal characters (cols, rows).

Examples

use tui_spinner::CircleSpinner;

let (cols, rows) = CircleSpinner::new(0).radius(4).char_size();
// dot_cols = 2*4+1 = 9, char_cols = ceil(9/2) = 5
// dot_rows = 2*4+1 = 9, char_rows = ceil(9/4) = 3
assert_eq!(cols, 5);
assert_eq!(rows, 3);

Trait Implementations

impl<'a> Clone for CircleSpinner<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CircleSpinner<'a>

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

Formats the value using the given formatter.

impl Styled for CircleSpinner<'_>

type Item = CircleSpinner<'_>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Self

Sets the style of the object.

impl Widget for &CircleSpinner<'_>

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.

impl Widget for CircleSpinner<'_>

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.