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
#[cfg(feature = "bytesize")] use std::fmt; use std::{ io::{self, prelude::*}, sync::{ atomic::{AtomicBool, AtomicU64, Ordering}, Arc, }, thread, time::{Duration, Instant}, }; #[cfg(feature = "bytesize")] use bytesize::ByteSize; use progress_streams::ProgressReader; #[derive(Default)] struct TransferState { transferred: AtomicU64, complete: AtomicBool, } /// Monitors the progress of a transfer from a [reader][Read] to a [writer][Write]. pub struct Transfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { start_time: Instant, state: Arc<TransferState>, handle: thread::JoinHandle<io::Result<(R, W)>>, } impl<R, W> Transfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { /// Creates and starts a new `Transfer`. /// # Example /// ```no_run /// use transfer_progress::Transfer; /// use std::fs::File; /// let reader = File::open("file1.txt")?; /// let writer = File::create("file2.txt")?; /// let transfer = Transfer::new(reader, writer); /// # Ok::<_, std::io::Error>(()) /// ``` pub fn new(reader: R, mut writer: W) -> Self { let state = Arc::new(TransferState::default()); let state_clone = Arc::clone(&state); let handle = thread::spawn(move || -> io::Result<(R, W)> { let mut reader = ProgressReader::new(reader, |bytes| { // If someone would like to confirm the correctness of the ordering guarantees, that would // be much appreciated. state_clone .transferred .fetch_add(bytes as u64, Ordering::Release); }); // We need to store the result and bubble it later so we can set the complete flag. let res = io::copy(&mut reader, &mut writer); state_clone.complete.store(true, Ordering::Release); res.map(|_| (reader.into_inner(), writer)) }); Self { start_time: Instant::now(), state, handle, } } /// Consumes the `Transfer`, blocking until the transfer is complete. /// /// If the transfer was successful, returns `Ok(reader, writer)`, otherwise returns /// the error. /// /// If the transfer is already complete, returns immediately. /// # Example /// ```no_run /// use transfer_progress::Transfer; /// use std::fs::File; /// let reader = File::open("file1.txt")?; /// let writer = File::create("file2.txt")?; /// let transfer = Transfer::new(reader, writer); /// let (reader, writer) = transfer.finish()?; /// # Ok::<_, std::io::Error>(()) /// ``` pub fn finish(self) -> io::Result<(R, W)> { self.handle.join().unwrap() } /// Tests if the transfer is complete /// # Example /// ```no_run /// use transfer_progress::Transfer; /// use std::fs::File; /// let reader = File::open("file1.txt")?; /// let writer = File::create("file2.txt")?; /// let transfer = Transfer::new(reader, writer); /// while !transfer.is_complete() { /// println!("Not complete yet"); /// std::thread::sleep(std::time::Duration::from_secs(1)); /// } /// println!("Complete!"); /// # Ok::<_, std::io::Error>(()) /// ``` pub fn is_complete(&self) -> bool { // If someone would like to confirm the correctness of the ordering guarantees, that would // be much appreciated. self.state.complete.load(Ordering::Acquire) } /// Returns the number of bytes transferred thus far between the reader and the writer. /// # Example /// ```no_run /// use transfer_progress::Transfer; /// use std::fs::File; /// let reader = File::open("file1.txt")?; /// let writer = File::create("file2.txt")?; /// let transfer = Transfer::new(reader, writer); /// while !transfer.is_complete() { /// println!("{} bytes transferred so far", transfer.transferred()); /// std::thread::sleep(std::time::Duration::from_secs(1)); /// } /// println!("Complete!"); /// # Ok::<_, std::io::Error>(()) /// ``` pub fn transferred(&self) -> u64 { // If someone would like to confirm the correctness of the ordering guarantees, that would // be much appreciated. self.state.transferred.load(Ordering::Acquire) } /// Returns the elapsed time since the transfer started. /// # Example /// ```no_run /// use transfer_progress::Transfer; /// use std::fs::File; /// let reader = File::open("file1.txt")?; /// let writer = File::create("file2.txt")?; /// let transfer = Transfer::new(reader, writer); /// while !transfer.is_complete() {} /// println!("Transfer took {:?}", transfer.running_time()); /// # Ok::<_, std::io::Error>(()) /// ``` pub fn running_time(&self) -> Duration { self.start_time.elapsed() } /// Returns the average speed, in bytes per second, of the transfer. /// # Example /// ```no_run /// use transfer_progress::Transfer; /// use std::fs::File; /// let reader = File::open("file1.txt")?; /// let writer = File::create("file2.txt")?; /// let transfer = Transfer::new(reader, writer); /// while !transfer.is_complete() { /// println!("{}B/s", transfer.speed()); /// std::thread::sleep(std::time::Duration::from_secs(1)); /// } /// # Ok::<_, std::io::Error>(()) /// ``` pub fn speed(&self) -> u64 { (self.transferred() as f64 / self.running_time().as_secs_f64()).round() as u64 } } #[cfg(feature = "bytesize")] impl<R, W> fmt::Debug for Transfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let transferred = ByteSize::b(self.transferred()); let speed = ByteSize::b(self.speed()); if f.alternate() { // Use SI units write!( f, "{:#} ({:#}/s)", transferred.to_string_as(true), speed.to_string_as(true) ) } else { write!(f, "{:#} ({:#}/s)", transferred, speed) } } } #[cfg(feature = "bytesize")] impl<R, W> fmt::Display for Transfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self, f) } } /// Monitors the progress of a transfer with a known size. pub struct SizedTransfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { inner: Transfer<R, W>, size: u64, } impl<R, W> SizedTransfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { /// Creates and starts a new `SizedTransfer`. /// # Example /// ```no_run /// use transfer_progress::SizedTransfer; /// use std::fs::File; /// use std::io::Read; /// let reader = File::open("file1.txt")?.take(1024); // Bytes /// let writer = File::create("file2.txt")?; /// let transfer = SizedTransfer::new(reader, writer, 1024); /// # Ok::<_, std::io::Error>(()) /// ``` pub fn new(reader: R, writer: W, size: u64) -> Self { Self { inner: Transfer::new(reader, writer), size, } } /// Consumes the `SizedTransfer`, blocking until the transfer is complete. /// /// If the transfer was successful, returns `Ok(reader, writer)`, otherwise returns /// the error. /// /// If the transfer is already complete, returns immediately. /// # Example /// ```no_run /// use transfer_progress::SizedTransfer; /// use std::fs::File; /// use std::io::Read; /// let reader = File::open("file1.txt")?.take(1024); // Bytes /// let writer = File::create("file2.txt")?; /// let transfer = SizedTransfer::new(reader, writer, 1024); /// let (reader, writer) = transfer.finish()?; /// # Ok::<_, std::io::Error>(()) /// ``` pub fn finish(self) -> io::Result<(R, W)> { self.inner.finish() } /// Returns a fraction between 0.0 and 1.0 representing the state of the transfer. /// # Example /// ```no_run /// use transfer_progress::SizedTransfer; /// use std::fs::File; /// use std::io::Read; /// let reader = File::open("file1.txt")?.take(1024); // Bytes /// let writer = File::create("file2.txt")?; /// let transfer = SizedTransfer::new(reader, writer, 1024); /// while !transfer.is_complete() { /// println!("Transfer is {:.0}% complete", transfer.fraction_transferred() * 100.0); /// std::thread::sleep(std::time::Duration::from_secs(1)); /// } /// # Ok::<_, std::io::Error>(()) /// ``` pub fn fraction_transferred(&self) -> f64 { self.transferred() as f64 / self.size as f64 } /// Returns the approximate remaining time until this transfer completes. Returns `None` if /// this cannot be calculated (I.E. no bytes have been transferred yet, so a speed cannot be /// determined). /// # Example /// ```no_run /// use transfer_progress::SizedTransfer; /// use std::fs::File; /// use std::io::Read; /// let reader = File::open("file1.txt")?.take(1024); // Bytes /// let writer = File::create("file2.txt")?; /// let transfer = SizedTransfer::new(reader, writer, 1024); /// while !transfer.is_complete() { /// if let Some(eta) = transfer.eta() { /// println!("Transfer will complete in approximately {:?}", eta); /// } else { /// println!("Transfer completion time is unknown"); /// } /// std::thread::sleep(std::time::Duration::from_secs(1)); /// } /// # Ok::<_, std::io::Error>(()) /// ``` pub fn eta(&self) -> Option<Duration> { // Cache this so we don't have to perform an atomic access twice let transferred = self.inner.transferred(); if transferred == 0 { return None; } let remaining = self.size - transferred; let elapsed = self.running_time().as_secs_f64(); let eta = (elapsed / transferred as f64) * remaining as f64; Some(Duration::from_secs_f64(eta)) } } impl<R, W> std::ops::Deref for SizedTransfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { type Target = Transfer<R, W>; fn deref(&self) -> &Self::Target { &self.inner } } #[cfg(feature = "bytesize")] impl<R, W> fmt::Debug for SizedTransfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let percentage = self.fraction_transferred() * 100.0; let transferred = ByteSize::b(self.transferred()); let size = ByteSize::b(self.size); let speed = ByteSize::b(self.speed()); if f.alternate() { write!( f, "{:.1} % ({} of {}, {}/s)", percentage, transferred, size, speed ) } else { write!( f, "{:.1} % ({} of {}, {}/s)", percentage, transferred.to_string_as(true), size.to_string_as(true), speed.to_string_as(true) ) } } } #[cfg(feature = "bytesize")] impl<R, W> fmt::Display for SizedTransfer<R, W> where R: Read + Send + 'static, W: Write + Send + 'static, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self, f) } }