Struct Spinner

pub struct Spinner {
    pub phase: f32,
    pub color: Color,
    pub size: f32,
    pub stroke_w: f32,
}

An indeterminate progress spinner.

Renders a rotating arc inside a square layout rect. The application drives the rotation by passing a monotonically-increasing phase value (any units — only the fractional part of phase is used).

Fields

phase: f32

Rotation phase. Only the fractional part is consumed, so any monotonically increasing source works (elapsed.as_secs_f32(), frame count divided by FPS, etc.).

color: Color

Arc / ring colour. Defaults to the theme’s accent palette slot.

size: f32

Square diameter in logical pixels. Both width and height of the laid-out rect target this size.

stroke_w: f32

Stroke width of the arc and the dim guide ring.

Implementations

impl Spinner

pub fn new() -> Self

Create a spinner with the theme’s accent colour and default size.

pub fn phase(self, p: f32) -> Self

Set the rotation phase. The widget consumes only the fractional part, so callers can pass an unbounded monotonic clock value.

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

Override the arc colour.

pub fn size(self, s: f32) -> Self

Set the square diameter in logical pixels.

pub fn stroke_width(self, w: f32) -> Self

Set the arc / ring stroke width in logical pixels.

pub fn preferred_size(&self, max_width: f32) -> (f32, f32)

Return the preferred (width, height) — the spinner is square.

pub fn draw(&self, canvas: &mut Canvas, rect: Rect)

Draw the spinner into canvas at rect. The arc is centred on rect’s minor diameter so the widget renders correctly even when laid out into a non-square cell.

Trait Implementations

impl Default for Spinner

fn default() -> Self

Returns the “default value” for a type.

impl<Msg: Clone> From<Spinner> for Element<Msg>

fn from(s: Spinner) -> Self

Converts to this type from the input type.