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
use pb::ProgressBar; use std::str::from_utf8; use tty::move_cursor_up; use std::io::{Stdout, Result, Write}; use std::sync::mpsc; use std::sync::mpsc::{Sender, Receiver}; pub struct MultiBar<T: Write> { nlines: usize, lines: Vec<String>, nbars: usize, chan: (Sender<WriteMsg>, Receiver<WriteMsg>), handle: T, } impl MultiBar<Stdout> { /// Create a new MultiBar with stdout as a writer. /// /// # Examples /// /// ```no_run /// use std::thread; /// use pbr::MultiBar; /// /// let mut mb = MultiBar::new(); /// mb.println("Application header:"); /// /// let mut p1 = mb.create_bar(count); /// let _ = thread::spawn(move || { /// for _ in 0..count { /// p1.inc(); /// thread::sleep(Duration::from_millis(100)); /// } /// // notify the multibar that this bar finished. /// p1.finish(); /// }); /// /// mb.println("add a separator between the two bars"); /// /// let mut p2 = mb.create_bar(count * 2); /// let _ = thread::spawn(move || { /// for _ in 0..count * 2 { /// p2.inc(); /// thread::sleep(Duration::from_millis(100)); /// } /// // notify the multibar that this bar finished. /// p2.finish(); /// }); /// /// // start listen to all bars changes. /// // this is a blocking operation, until all bars will finish. /// // to ignore blocking, you can run it in a different thread. /// mb.listen(); /// ``` pub fn new() -> MultiBar<Stdout> { MultiBar::on(::std::io::stdout()) } } impl<T: Write> MultiBar<T> { /// Create a new MultiBar with an arbitrary writer. /// /// # Examples /// /// ```no_run /// use pbr::MultiBar; /// use std::io::stderr; /// /// let mut mb = MultiBar::on(stderr()); /// // ... /// // see full example in `MultiBar::new` /// // ... /// ``` pub fn on(handle: T) -> MultiBar<T> { MultiBar { nlines: 0, nbars: 0, lines: Vec::new(), chan: mpsc::channel(), handle: handle, } } /// println used to add text lines between the bars. /// for example: you could add a header to your application, /// or text separators between bars. /// /// # Examples /// /// ```no_run /// use pbr::MultiBar; /// /// let mut mb = MultiBar::new(); /// mb.println("Application header:"); /// /// let mut p1 = MultiBar::create_bar(count); /// // ... /// /// mb.println("Text line between bar1 and bar2"); /// /// let mut p2 = MultiBar::create_bar(count); /// // ... /// /// mb.println("Text line between bar2 and bar3"); /// /// // ... /// // ... /// mb.listen(); /// ``` pub fn println(&mut self, s: &str) { self.lines.push(s.to_owned()); self.nlines += 1; } /// create_bar creates new `ProgressBar` with `Pipe` as the writer. /// /// The ordering of the method calls is important. it means that in /// the first call, you get a progress bar in level 1, in the 2nd call, /// you get a progress bar in level 2, and so on. /// /// ProgressBar that finish its work, must call `finish()` (or `finish_print`) /// to notify the `MultiBar` about it. /// /// # Examples /// /// ```no_run /// use pbr::MultiBar; /// /// let mut mb = MultiBar::new(); /// /// // progress bar in level 1 /// let mut p1 = MultiBar::create_bar(count1); /// // ... /// /// // progress bar in level 2 /// let mut p2 = MultiBar::create_bar(count2); /// // ... /// /// // progress bar in level 3 /// let mut p3 = MultiBar::create_bar(count3); /// /// // ... /// mb.listen(); /// ``` pub fn create_bar(&mut self, total: u64) -> ProgressBar<Pipe> { self.println(""); self.nbars += 1; let mut p = ProgressBar::on(Pipe { level: self.nlines - 1, chan: self.chan.0.clone(), }, total); p.is_multibar = true; p.add(0); p } /// listen start listen to all bars changes. /// /// `ProgressBar` that finish its work, must call `finish()` (or `finish_print`) /// to notify the `MultiBar` about it. /// /// This is a blocking operation and blocks until all bars will /// finish. /// To ignore blocking, you can run it in a different thread. /// /// # Examples /// /// ```no_run /// use pbr::MultiBar; /// /// let mut mb = MultiBar::new(); /// /// // ... /// // create some bars here /// // ... /// /// thread::spawn(move || { /// mb.listen(); /// println!("all bars done!"); /// }); /// /// // ... /// ``` pub fn listen(&mut self) { let mut first = true; let mut nbars = self.nbars; while nbars > 0 { // receive message let msg = self.chan.1.recv().unwrap(); if msg.done { nbars -= 1; continue; } self.lines[msg.level] = msg.string; // and draw let mut out = String::new(); if !first { out += &move_cursor_up(self.nlines); } else { first = false; } for l in self.lines.iter() { out.push_str(&format!("\r{}\n", l)); } printfl!(self.handle, "{}", out); } } } pub struct Pipe { level: usize, chan: Sender<WriteMsg>, } impl Write for Pipe { fn write(&mut self, buf: &[u8]) -> Result<usize> { let s = from_utf8(buf).unwrap().to_owned(); self.chan .send(WriteMsg { // finish method emit empty string done: s == "", level: self.level, string: s, }) .unwrap(); Ok(1) } fn flush(&mut self) -> Result<()> { Ok(()) } } // WriteMsg is the message format used to communicate // between MultiBar and its bars struct WriteMsg { done: bool, level: usize, string: String, }