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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
//! This library is primarily concerned with generating strings that can be used by your favorite //! terminal stream manipulation system to display a progress bar. //! //! #### Example //! //! ```no_run //! extern crate progress_string; //! extern crate termion; //! //! use std::thread::sleep; //! use std::time::Duration; //! //! const TOTAL: usize = 1000; //! //! fn main() { //! let mut bar = progress_string::BarBuilder::new() //! .total(TOTAL) //! .include_percent() //! .get_bar(); //! //! println!("starting the progress"); //! for i in 0..TOTAL { //! bar.replace(i); //! print!( //! "{}{}", //! termion::cursor::Left(bar.get_last_width() as u16), //! bar.to_string() //! ); //! sleep(Duration::from_millis(10)); //! } //! println!("\ndone with progress"); //! } //! ``` /// Represents a progress bar which can be used to get your progress string. pub struct Bar { pub current_partial: usize, pub total: usize, width: usize, empty_char: char, full_char: char, include_percent: bool, include_numbers: bool, previous_text_width: usize, } /// Helper struct for building a progress bar. /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let bar = BarBuilder::new() /// .total(1000000) /// .width(20) /// .empty_char('0') /// .full_char('X') /// .include_percent() /// .get_bar(); /// ``` /// the above would look something like this /// `[XXXXXXXXXX0000000000] 50.00%` pub struct BarBuilder { bar: Bar, } impl Default for BarBuilder { fn default() -> Self { BarBuilder::new() } } impl BarBuilder { /// Create a new `BarBuilder`. pub fn new() -> Self { BarBuilder { bar: Bar::default(), } } /// Update the total (default 100). /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let thousand = BarBuilder::new().total(1000).get_bar(); /// // yields [█ ] /// ``` pub fn total(mut self, total: usize) -> BarBuilder { self.bar.total = total; self } /// Update the progress section's width (default 50). /// ``` /// use progress_string::BarBuilder; /// /// let bar = BarBuilder::new().width(10); /// // yields [ ] /// ``` pub fn width(mut self, width: usize) -> BarBuilder { self.bar.width = width; self } /// Update the character you want to use as an empty section of the progress bar (default ' '). /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let zero_emp = BarBuilder::new().empty_char('0').get_bar(); /// // yields /// // [██████████00000000000] /// ``` pub fn empty_char(mut self, character: char) -> BarBuilder { self.bar.empty_char = character; self } /// Update the character you want to use as a full section of the bar (default '█'). /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let x_bar = BarBuilder::new().full_char('X').get_bar(); /// // yields [XXXXXX ] /// let y_bar = BarBuilder::new().full_char('Y').get_bar(); /// // yields [YYYYYY ] /// ``` pub fn full_char(mut self, character: char) -> BarBuilder { self.bar.full_char = character; self } /// Update the bar to include the percent after the bar representation (default `false`). /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let no_p = BarBuilder::new().include_percent().get_bar(); /// // yields [██████████ ] 50.00% /// let with_p = BarBuilder::new(); /// // yields [██████████ ] /// ``` pub fn include_percent(mut self) -> BarBuilder { self.bar.include_percent = true; self } /// Update the bar to include the divison after the bar representation. /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let mut no_n = BarBuilder::new().get_bar(); /// no_n.replace(50); /// // yields [██████████ ] /// let mut with_n = BarBuilder::new().include_numbers().get_bar(); /// with_n.replace(50) /// // yields [██████████ ] 50/100 /// ``` pub fn include_numbers(mut self) -> BarBuilder { self.bar.include_numbers = true; self } /// Complete building your bar and return the updated struct. /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let bar = BarBuilder::new().get_bar(); /// // yields a default bar instance /// ``` pub fn get_bar(self) -> Bar { self.bar } } impl Default for Bar { /// Bar constructor with default values. /// ```text /// Bar { /// current_partial: 0, /// total: 100, /// width: 50, /// full_char: '█', /// empty_char: ' ', /// include_percent: false, /// include_numbers: false, /// previous_text_width: 0 /// } /// ``` fn default() -> Self { Self { current_partial: 0, total: 100, width: 50, full_char: '█', empty_char: ' ', include_percent: false, include_numbers: false, previous_text_width: 0, } } } impl Bar { /// Update the `current_partial` value by adding the `to_add` parameter. /// /// #### Examples /// ``` /// use progress_string::Bar; /// /// let mut bar = Bar::default(); /// bar.update(10); /// assert_eq!(bar.current_partial, 10); /// ``` pub fn update(&mut self, to_add: usize) { self.previous_text_width = self.get_width(); self.current_partial += to_add; } /// Update the current partial by replacing the current value. /// /// #### Examples /// ``` /// use progress_string::Bar; /// /// let mut bar = Bar::default(); /// bar.replace(10); /// assert_eq!(bar.current_partial, 10); /// ``` pub fn replace(&mut self, new_progress: usize) { self.previous_text_width = self.get_width(); self.current_partial = new_progress; } /// Get the current width of characters in the bar. /// /// This includes the brackets, spaces and percent if set. /// /// #### Examples /// ``` /// use progress_string::{Bar, BarBuilder}; /// /// let bar = Bar::default(); /// assert_eq!(bar.get_width(), 52); /// /// let mut with_percent = BarBuilder::new().include_percent().get_bar(); /// assert_eq!(with_percent.get_width(), 58); /// /// with_percent.update(10); /// assert_eq!(with_percent.get_width(), 59); /// /// with_percent.replace(100); /// assert_eq!(with_percent.get_width(), 60); /// ``` pub fn get_width(&self) -> usize { let mut width: usize = 52; if self.include_numbers { let total_string = format!("{}", self.total); let partial_string = format!("{}", self.current_partial); width += total_string.len() + partial_string.len() + 2; } if self.include_percent { let current_percent = self.calculate_percent(); if current_percent >= 0.95 { width += 8; } else if current_percent > 0.095 { width += 7; } else { width += 6; } } width } /// Similar to `get_width` but gets the value before the last `update` or `replace` call. /// /// This is useful for when you are trying to clear the terminal. pub fn get_last_width(&self) -> usize { self.previous_text_width } fn calculate_percent(&self) -> f32 { self.current_partial as f32 / self.total as f32 } } impl std::fmt::Display for Bar { /// Get the string representation of the progress bar. /// /// This string will include brackets ([]) around the empty/full characters. The width is /// determined by the width property. If `bar.include_percent == true`, the resulting string /// will include a space and the percent with 2 decimal places followed by %. /// /// #### Examples /// ``` /// use progress_string::BarBuilder; /// /// let mut with_percent = BarBuilder::new().include_percent().get_bar(); /// with_percent.update(50); /// println!("{}", with_percent.to_string()); /// // prints [█████████████████████████ ] 50.00% /// let mut no_percent = BarBuilder::new().get_bar(); /// no_percent.update(50); /// // prints [█████████████████████████ ] /// ``` fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { let percent = self.calculate_percent(); let mut progress_bar = String::from("["); for i in 0..self.width { if (i as f32) < (self.width as f32 * percent) { progress_bar.push(self.full_char); } else { progress_bar.push(self.empty_char); } } progress_bar.push(']'); if self.include_percent { progress_bar.push_str(format!(" {:.2}%", percent * 100.0).as_str()); } if self.include_numbers { progress_bar.push_str(format!(" {:?}/{:?}", self.current_partial, self.total).as_str()); } write!(f, "{}", progress_bar) } } #[cfg(test)] mod tests { use super::*; #[test] fn include_percent_test() { let mut bar = BarBuilder::new().include_percent().get_bar(); assert_eq!(bar.get_width(), 58); bar.update(50); assert_eq!(bar.get_width(), 59); bar.update(50); assert_eq!(bar.get_width(), 60); } #[test] fn include_numbers_test() { let mut bar = BarBuilder::new().include_numbers().get_bar(); assert_eq!(bar.get_width(), 58); bar.update(50); assert_eq!(bar.get_width(), 59); bar.update(50); assert_eq!(bar.get_width(), 60); } #[test] fn update_test() { let mut bar = Bar::default(); bar.update(50); } #[test] fn replace_test() { let mut bar = Bar::default(); bar.replace(10); } #[test] fn to_string_test() { let mut bar = Bar::default(); assert_eq!( bar.to_string(), "[ ]" ); bar.update(50); assert_eq!( bar.to_string(), "[█████████████████████████ ]" ) } }