ttycarousel 0.1.5

Console animations for Rust
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! # ttycarousel - Console animations for Rust
//!
//! This crate provides a simple carousel animation for console, to ensure your
//! users do not get bored and do not think that the program is dead.
//!
//! <img
//! src="https://raw.githubusercontent.com/divi255/ttycarousel/main/demo.gif" />
//!
//! Crate: <https://crates.io/crates/ttycarousel>
//!
//! ## Sync programs
//!
//! Add to Cargo.toml:
//!
//! ```toml
//! [dependencies]
//! ttycarousel = { version = "*", features = ["sync"] }
//! ```
//!
//! ### Simple
//!
//! ```rust
//! use std::time::Duration;
//!
//! ttycarousel::spawn0("working");
//! std::thread::sleep(Duration::from_secs(2));
//! ttycarousel::stop();
//! println!("work completed!");
//! ```
//!
//! ### With options
//!
//! ```rust
//! use std::time::Duration;
//!
//! ttycarousel::spawn(
//!     "working",
//!     ttycarousel::Options::new()
//!         .speed(50)
//!         .color(ttycarousel::Color::Yellow)
//!         .bold(),
//! );
//! std::thread::sleep(Duration::from_secs(2));
//! ttycarousel::stop();
//! ```
//!
//! ## Async (Tokio)
//!
//! Add to Cargo.toml:
//!
//! ```toml
//! [dependencies]
//! ttycarousel = { version = "*", features = ["tokio1"] }
//! ```
//!
//! Async example:
//!
//! ```rust
//! use std::time::Duration;
//!
//! async fn task1() {
//!     ttycarousel::tokio1::spawn(
//!         "working",
//!         ttycarousel::Options::new()
//!             .speed(50)
//!             .color(ttycarousel::Color::Yellow)
//!             .bold(),
//!     ).await;
//!     //ttycarousel::tokio1::spawn0("working").await; // with defaults
//!     tokio::time::sleep(Duration::from_secs(2)).await;
//!     ttycarousel::tokio1::stop().await;
//!     println!("work completed!");
//! }
//! ```
//!
//! ## P.S.
//!
//! Yep, I had nothing to do.
use std::time::Duration;

#[cfg(any(feature = "sync", feature = "tokio1"))]
mod carousel;
#[cfg(feature = "sync")]
pub mod sync;
#[cfg(feature = "tokio1")]
pub mod tokio1;

#[cfg(feature = "sync")]
pub use sync::{spawn, spawn0, stop, stop_clear, stop_with};

const DEFAULT_DELAY: Duration = Duration::from_millis(50);

#[derive(Copy, Clone)]
pub struct Options {
    reverse: bool,
    delay: Duration,
    color: Option<Color>,
    bold: bool,
}

impl Default for Options {
    #[inline]
    fn default() -> Self {
        Self {
            reverse: false,
            delay: DEFAULT_DELAY,
            color: None,
            bold: false,
        }
    }
}

impl Options {
    #[inline]
    pub fn new() -> Self {
        Self::default()
    }
    #[inline]
    pub fn reverse(mut self) -> Self {
        self.reverse = true;
        self
    }
    #[inline]
    pub fn speed(mut self, speed: u64) -> Self {
        self.delay = Duration::from_millis(speed);
        self
    }
    #[inline]
    pub fn color(mut self, color: Color) -> Self {
        self.color.replace(color);
        self
    }
    #[inline]
    pub fn bold(mut self) -> Self {
        self.bold = true;
        self
    }
}

#[derive(Copy, Clone)]
#[repr(u8)]
pub enum Color {
    Black = 0,
    Red = 1,
    Green = 2,
    Yellow = 3,
    Blue = 4,
    Magenta = 5,
    Cyan = 6,
    White = 7,
}

impl Color {
    #[cfg(any(feature = "sync", feature = "tokio1"))]
    #[inline]
    fn as_escape(self) -> [u8; 5] {
        [0x1b, b'[', b'3', self as u8 + 48, b'm']
    }
}