Struct Spinner 

pub struct Spinner { /* private fields */ }

A one-cell indicator that something is working, with an optional label.

It plays a cell animation: a SpinnerStyle or any animation by name. With reduced motion the animation’s rest frame stands still. Style keys: spinner (fg, with variants for tones such as spinner.success) and spinner-label. The spinner’s colour is the $fg of its animation.

With Spinner::done the spinner stops turning and plays the animation spinner-done once: the built-in one grows a tick, one motion.step per frame, blending from the colour on screen into $success, and rests on the last frame.

Implementations

impl Spinner

pub fn new() -> Self

An arc spinner, the default style.

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

Chooses how it moves.

pub fn animation(self, name: impl Into<AnimationName>) -> Self

Plays the animation name from the icon set or theme instead of a style, e.g. one an application defines in its theme. An unknown name draws ⟦, like a missing icon.

pub fn label(self, label: impl Into<String>) -> Self

Text after the spinner, e.g. “Pulling image”.

pub fn variant(self, variant: impl Into<String>) -> Self

Theme variant, e.g. "success" or "warning".

pub fn done(self, done: bool) -> Self

Marks the work as finished. When this turns on, the spinner stops turning, plays the animation spinner-done once, starting from the colour on screen, and rests on its last frame. Turning it off spins again. A spinner that is already done when first drawn, or drawn with reduced motion, shows the last frame at once. The cell and the label stay where they are. Off by default.

Trait Implementations

impl Clone for Spinner

fn clone(&self) -> Spinner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spinner

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

Formats the value using the given formatter.

impl Default for Spinner

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Spinner

impl PartialEq for Spinner

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Spinner

impl<Msg: 'static> Widget<Msg> for Spinner

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn event(&self, _cx: &mut EventCx<'_, Msg>, _event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.