Struct SpinnerBuilder

Source

pub struct SpinnerBuilder { /* private fields */ }

Expand description

A builder for creating a terminal spinner.

Implementations§

Source §

impl<'a> SpinnerBuilder

Source

pub fn new() -> Self

Creates a new builder.

Examples found in repository ?

examples/arc.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&ARC).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

More examples

Hide additional examples

examples/dots.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DOTS).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/dqpb.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DQPB).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/flip.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&FLIP).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/line.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&LINE).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/moon.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&MOON).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

Additional examples can be found in:

Source

pub fn spinner(self, spinner: &'static SpinnerData<'static>) -> Self

The spinner animation to use.

Examples found in repository ?

examples/arc.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&ARC).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

More examples

Hide additional examples

examples/dots.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DOTS).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/dqpb.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DQPB).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/flip.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&FLIP).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/line.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&LINE).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/moon.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&MOON).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

Additional examples can be found in:

Source

pub fn text(self, text: impl Into<Cow<'static, str>>) -> Self

The text to show after the spinner animation.

Examples found in repository ?

examples/arc.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&ARC).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

More examples

Hide additional examples

examples/dots.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DOTS).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/dqpb.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DQPB).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/flip.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&FLIP).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/line.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&LINE).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/moon.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&MOON).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

Additional examples can be found in:

Source

pub fn prefix(self, prefix: impl Into<Cow<'static, str>>) -> Self

The prefix to print before the actual spinning animation.

§Note

The prefix must not include newlines, as the library deletion does not account for those.

Examples found in repository ?

examples/prefix.rs (line 8)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new()
6        .spinner(&DOTS)
7        .text(text)
8        .prefix("  ")
9        .start();
10    thread::sleep(Duration::from_secs(3));
11    handle.done();
12}

Source

pub fn start(self) -> SpinnerHandle

Starts the spinner and renders it on a separate thread.

§Returns

A SpinnerHandle, allowing for further control of the spinner after it gets rendered.

§Panics

If no text and spinner have been set.

Examples found in repository ?

examples/arc.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&ARC).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

More examples

Hide additional examples

examples/dots.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DOTS).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/dqpb.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&DQPB).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/flip.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&FLIP).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/line.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&LINE).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}

examples/moon.rs (line 5)

3fn main() {
4    let text = "Loading unicorns";
5    let handle = SpinnerBuilder::new().spinner(&MOON).text(text).start();
6    thread::sleep(Duration::from_secs(3));
7    handle.done();
8}