Enum LinearStyle 

pub enum LinearStyle {
    Classic,
    Square,
    Diamond,
    Bar,
    Braille,
    Arrow,
}

The symbol pair used to draw active and inactive slot positions.

Each variant defines an (active, inactive) character pair rendered with bold + active_color / inactive_color respectively.

Examples

use tui_spinner::{LinearSpinner, LinearStyle};

let spinner = LinearSpinner::new(0).linear_style(LinearStyle::Diamond);

Variants

Classic

● / · — filled circle / middle dot. The original classic look.

Square

■ / □ — filled square / open square.

Diamond

◆ / ◇ — filled diamond / open diamond.

Bar

▰ / ▱ — parallelogram filled / parallelogram empty.

Braille

⣿ / ⠀ — full braille cell / blank braille cell.

Arrow

▶ / ▷ — filled right-arrow / open right-arrow. Rotates to ▼ / ▽ when Direction::Vertical is used.

Implementations

impl LinearStyle

pub const fn symbols(self, direction: Direction) -> (&'static str, &'static str)

Returns the (active, inactive) string pair for this style, optionally adjusted for the given direction.

pub const fn columns_per_slot(self) -> u16

Returns the number of terminal columns each slot occupies.

Most symbols are 1 column wide in a typical Western terminal. Symbols whose Unicode East Asian Width property is “Wide” occupy 2 columns; callers that lay out the spinner area manually (e.g. in a Ratatui Layout) should multiply total_slots by this value to get the correct Constraint::Length value.

Examples

use tui_spinner::{Direction, LinearStyle};

// Allocate exactly the right width for a 5-slot horizontal spinner:
let style = LinearStyle::Classic;
let width = 5 * style.columns_per_slot();
assert_eq!(width, 5);

Trait Implementations

impl Clone for LinearStyle

fn clone(&self) -> LinearStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinearStyle

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

Formats the value using the given formatter.

impl Default for LinearStyle

fn default() -> LinearStyle

Returns the “default value” for a type.

impl PartialEq for LinearStyle

fn eq(&self, other: &LinearStyle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for LinearStyle

impl Eq for LinearStyle

impl StructuralPartialEq for LinearStyle