mirror of
https://github.com/nushell/nushell.git
synced 2024-11-22 16:33:37 +01:00
6fd854ed9f
# Description
This PR introduces a `ByteStream` type which is a `Read`-able stream of
bytes. Internally, it has an enum over three different byte stream
sources:
```rust
pub enum ByteStreamSource {
Read(Box<dyn Read + Send + 'static>),
File(File),
Child(ChildProcess),
}
```
This is in comparison to the current `RawStream` type, which is an
`Iterator<Item = Vec<u8>>` and has to allocate for each read chunk.
Currently, `PipelineData::ExternalStream` serves a weird dual role where
it is either external command output or a wrapper around `RawStream`.
`ByteStream` makes this distinction more clear (via `ByteStreamSource`)
and replaces `PipelineData::ExternalStream` in this PR:
```rust
pub enum PipelineData {
Empty,
Value(Value, Option<PipelineMetadata>),
ListStream(ListStream, Option<PipelineMetadata>),
ByteStream(ByteStream, Option<PipelineMetadata>),
}
```
The PR is relatively large, but a decent amount of it is just repetitive
changes.
This PR fixes #7017, fixes #10763, and fixes #12369.
This PR also improves performance when piping external commands. Nushell
should, in most cases, have competitive pipeline throughput compared to,
e.g., bash.
| Command | Before (MB/s) | After (MB/s) | Bash (MB/s) |
| -------------------------------------------------- | -------------:|
------------:| -----------:|
| `throughput \| rg 'x'` | 3059 | 3744 | 3739 |
| `throughput \| nu --testbin relay o> /dev/null` | 3508 | 8087 | 8136 |
# User-Facing Changes
- This is a breaking change for the plugin communication protocol,
because the `ExternalStreamInfo` was replaced with `ByteStreamInfo`.
Plugins now only have to deal with a single input stream, as opposed to
the previous three streams: stdout, stderr, and exit code.
- The output of `describe` has been changed for external/byte streams.
- Temporary breaking change: `bytes starts-with` no longer works with
byte streams. This is to keep the PR smaller, and `bytes ends-with`
already does not work on byte streams.
- If a process core dumped, then instead of having a `Value::Error` in
the `exit_code` column of the output returned from `complete`, it now is
a `Value::Int` with the negation of the signal number.
# After Submitting
- Update docs and book as necessary
- Release notes (e.g., plugin protocol changes)
- Adapt/convert commands to work with byte streams (high priority is
`str length`, `bytes starts-with`, and maybe `bytes ends-with`).
- Refactor the `tee` code, Devyn has already done some work on this.
---------
Co-authored-by: Devyn Cairns <devyn.cairns@gmail.com>
57 lines
2.0 KiB
Rust
57 lines
2.0 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,
|
|
}
|
|
|
|
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}] [{bar:30.cyan/blue}] [{bytes}/{total_bytes}] {binary_bytes_per_sec} ({eta}) {wide_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} {wide_msg}",
|
|
)
|
|
}
|
|
};
|
|
|
|
let total_bytes = total_bytes.unwrap_or_default();
|
|
|
|
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,
|
|
}
|
|
}
|
|
|
|
pub fn update_bar(&mut self, bytes_processed: u64) {
|
|
self.pb.set_position(bytes_processed);
|
|
}
|
|
|
|
#[allow(dead_code)]
|
|
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);
|
|
}
|
|
}
|