Struct Spinner 

pub struct Spinner<S> { /* private fields */ }

A Spinach spinner

Represents a spinner that can be used to show progress or activity.

Examples

use spinach::Spinner;

let spinner = Spinner::new("Loading...").start();
// Perform some tasks
spinner.text("gg!").success();

Implementations

impl<S> Spinner<S>

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

Sets the color of the spinner.

Examples

use spinach::{Spinner, Color};

let spinner = Spinner::new("workin'...").color(Color::Blue).start();

Examples found in repository

examples/cooking.rs (line 9)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

pub fn text(&self, text: &str) -> &Self

Sets the text displayed alongside the spinner.

Examples

use spinach::Spinner;

let spinner = Spinner::new("workin'...").start();

Examples found in repository

examples/cooking.rs (line 14)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

pub fn symbols(&self, symbols: Vec<&'static str>) -> &Self

Sets the symbols used for the spinner animation.

Examples

use spinach::Spinner;

let spinner = Spinner::new("workin'...").symbols(vec!["◐", "◓", "◑", "◒"]).start();

pub fn symbol(&self, symbol: &'static str) -> &Self

Sets a single symbol for the spinner animation. This is useful when you want to set a final symbol, for example.

Examples

use spinach::Spinner;

let spinner = Spinner::new("workin'...").start().text("done!").symbol("✔").stop();

Examples found in repository

examples/cooking.rs (line 17)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

pub fn frames_duration(&self, ms: u64) -> &Self

Sets the duration of each frame in the spinner animation.

Examples

use spinach::Spinner;

let spinner = Spinner::new("workin'...").frames_duration(40).start();

Examples found in repository

examples/cooking.rs (line 10)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

impl Spinner<Stopped>

pub fn new(text: &str) -> Self

Creates a new spinner.

Examples

use spinach::Spinner;

let spinner = Spinner::new("let's go...").start();

Examples found in repository

examples/cooking.rs (line 8)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

pub fn start(&self) -> Spinner<Running>

Starts the spinner.

Examples

use spinach::Spinner;

let spinner = Spinner::new("let's go...").start();

Examples found in repository

examples/cooking.rs (line 11)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

impl Spinner<Running>

pub fn update(&self) -> &Self

Updates the spinner with the current update state.

Examples

use spinach::Spinner;

let spinner = Spinner::new("Doing something...").start();
// Perform some tasks
spinner.text("Doing something else...").update();

Examples found in repository

examples/cooking.rs (line 14)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

pub fn stop(&self)

Stops the spinner.

Examples

use spinach::Spinner;

let spinner = Spinner::new("Doing something...").start();
// Perform some tasks
spinner.text("done!").stop();

Examples found in repository

examples/cooking.rs (line 17)

fn main() {
    let spinner = Spinner::new("Cutting spinaches")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Cutting tomatoes").update();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cut").symbol("🔪").stop();

    let spinner = Spinner::new("Cooking vegetables")
        .color(Green)
        .frames_duration(30)
        .start();

    sleep(Duration::from_secs(1));
    spinner.text("Vegetables cooked").symbol("🍲").stop();

    sleep(Duration::from_secs(1));
}

pub fn success(&self)

Stops the spinner with a pre-configured success indication. Sets the symbol and color.

Examples

use spinach::Spinner;

let spinner = Spinner::new("Doing something...").start();
// Perform some task that succeeds
spinner.text("done!").success();

pub fn failure(&self)

Stops the spinner with a pre-configured failure indication. Sets the symbol and color.

Examples

use spinach::Spinner;

let spinner = Spinner::new("Doing something...").start();
// Perform some task that fails
spinner.text("oops").failure();

pub fn warn(&self)

Stops the spinner with a pre-configured warning indication. Sets the symbol and color.

Examples

use spinach::Spinner;

let spinner = Spinner::new("Doing something...").start();
// Perform some task with unexpected results
spinner.text("wait, what?").warn();

Trait Implementations

impl<S: Clone> Clone for Spinner<S>

fn clone(&self) -> Spinner<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Spinner<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Spinner<S>

fn default() -> Spinner<S>

Returns the “default value” for a type.