mirror of
https://github.com/nushell/nushell
synced 2025-01-08 11:18:58 +00:00
82ac590412
# Description _(Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.)_ I implemented the status bar we talk about yesterday. The idea was inspired by the progress bar of `wget`. I decided to go for the second suggestion by `@Reilly` > 2. add an Option<usize> or whatever to RawStream (and ListStream?) for situations where you do know the length ahead of time For now only works with the command `save` but after the approve of this PR we can see how we can implement it on commands like `cp` and `mv` When using `fetch` nushell will check if there is any `content-length` attribute in the request header. If so, then `fetch` will send it through the new `Option` variable in the `RawStream` to the `save`. If we know the total size we show the progress bar  but if we don't then we just show the stats like: data already saved, bytes per second, and time lapse.   Please let me know If I need to make any changes and I will be happy to do it. # User-Facing Changes A new flag (`--progress` `-p`) was added to the `save` command Examples: ```nu fetch https://github.com/torvalds/linux/archive/refs/heads/master.zip | save --progress -f main.zip fetch https://releases.ubuntu.com/22.04.1/ubuntu-22.04.1-desktop-amd64.iso | save --progress -f main.zip open main.zip --raw | save --progress main.copy ``` # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - I am getting some errors and its weird because the errors are showing up in files i haven't touch. Is this normal? # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. Co-authored-by: Reilly Wood <reilly.wood@icloud.com>
71 lines
2.4 KiB
Rust
71 lines
2.4 KiB
Rust
use indicatif::{ProgressBar, ProgressState, ProgressStyle};
|
|
use std::fmt;
|
|
|
|
// This module includes the progress bar used to show the progress when using the command `save`
|
|
// Eventually it would be nice to find a better place for it.
|
|
|
|
pub struct NuProgressBar {
|
|
pub pb: ProgressBar,
|
|
bytes_processed: u64,
|
|
total_bytes: Option<u64>,
|
|
}
|
|
|
|
impl NuProgressBar {
|
|
pub fn new(total_bytes: Option<u64>) -> NuProgressBar {
|
|
// Let's create the progress bar template.
|
|
let template = match total_bytes {
|
|
Some(_) => {
|
|
// We will use a progress bar if we know the total bytes of the stream
|
|
ProgressStyle::with_template("{spinner:.green} [{elapsed_precise}] [{wide_bar:.cyan/blue}] {bytes}/{total_bytes} {binary_bytes_per_sec} ({eta}) {msg}")
|
|
}
|
|
_ => {
|
|
// But if we don't know the total then we just show the stats progress
|
|
ProgressStyle::with_template(
|
|
"{spinner:.green} [{elapsed_precise}] {bytes} {binary_bytes_per_sec} {msg}",
|
|
)
|
|
}
|
|
};
|
|
|
|
let total_bytes = match total_bytes {
|
|
Some(total_size) => total_size,
|
|
_ => 0,
|
|
};
|
|
|
|
let new_progress_bar = ProgressBar::new(total_bytes);
|
|
new_progress_bar.set_style(
|
|
template
|
|
.unwrap_or_else(|_| ProgressStyle::default_bar())
|
|
.with_key("eta", |state: &ProgressState, w: &mut dyn fmt::Write| {
|
|
let _ = fmt::write(w, format_args!("{:.1}s", state.eta().as_secs_f64()));
|
|
})
|
|
.progress_chars("#>-"),
|
|
);
|
|
|
|
NuProgressBar {
|
|
pb: new_progress_bar,
|
|
total_bytes: None,
|
|
bytes_processed: 0,
|
|
}
|
|
}
|
|
|
|
pub fn update_bar(&mut self, bytes_processed: u64) {
|
|
self.pb.set_position(bytes_processed);
|
|
}
|
|
|
|
// Commenting this for now but adding it in the future
|
|
//pub fn finished_msg(&self, msg: String) {
|
|
// self.pb.finish_with_message(msg);
|
|
//}
|
|
|
|
pub fn abandoned_msg(&self, msg: String) {
|
|
self.pb.abandon_with_message(msg);
|
|
}
|
|
|
|
pub fn clone(&self) -> NuProgressBar {
|
|
NuProgressBar {
|
|
pb: self.pb.clone(),
|
|
bytes_processed: self.bytes_processed,
|
|
total_bytes: self.total_bytes,
|
|
}
|
|
}
|
|
}
|