promkit-widgets 0.6.0

Widgets for promkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use std::time::Duration;

use crate::core::{grapheme::StyledGraphemes, render::SharedRenderer};

pub mod frame;
use frame::Frame;

/// Trait to define the state of the spinner.
pub trait State {
    fn is_idle(&self) -> impl Future<Output = bool> + Send;
}

/// A spinner that can be used to indicate loading or processing states.
#[derive(Clone, Debug)]
pub struct Spinner {
    /// The frames of the spinner, which are the characters that will be displayed in a rotating manner.
    pub frames: Frame,
    /// A suffix that will be displayed alongside the spinner.
    pub suffix: String,
    /// The duration between frame updates.
    pub duration: Duration,
}

impl Default for Spinner {
    fn default() -> Self {
        Self {
            frames: frame::DOTS,
            suffix: String::new(),
            duration: Duration::from_millis(100),
        }
    }
}

impl Spinner {
    /// Set frames for the spinner.
    pub fn frames(mut self, frames: Frame) -> Self {
        self.frames = frames;
        self
    }

    /// Set a suffix for the spinner.
    pub fn suffix(mut self, suffix: impl Into<String>) -> Self {
        self.suffix = suffix.into();
        self
    }

    /// Set the duration between frame updates.
    pub fn duration(mut self, duration: Duration) -> Self {
        self.duration = duration;
        self
    }
}

/// Spawn a background task that shows a spinner while the state is active.
pub async fn run<S, I>(
    spinner: &Spinner,
    state: S,
    index: I,
    renderer: SharedRenderer<I>,
) -> anyhow::Result<()>
where
    S: State,
    I: Clone + Ord + Send,
{
    let mut frame_index = 0;
    let mut interval = tokio::time::interval(spinner.duration);

    loop {
        interval.tick().await;

        if !state.is_idle().await {
            frame_index = (frame_index + 1) % spinner.frames.len();

            renderer
                .update([(
                    index.clone(),
                    StyledGraphemes::from(format!(
                        "{} {}",
                        spinner.frames[frame_index], spinner.suffix
                    )),
                )])
                .render()
                .await?;
        }
    }
}