mirror of
https://github.com/nushell/nushell.git
synced 2025-05-08 20:14:26 +02: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>
42 lines
771 B
Rust
42 lines
771 B
Rust
mod alias;
|
|
pub mod ast;
|
|
pub mod config;
|
|
pub mod debugger;
|
|
mod did_you_mean;
|
|
pub mod engine;
|
|
mod errors;
|
|
pub mod eval_base;
|
|
pub mod eval_const;
|
|
mod example;
|
|
mod id;
|
|
mod lev_distance;
|
|
mod module;
|
|
mod pipeline;
|
|
#[cfg(feature = "plugin")]
|
|
mod plugin;
|
|
pub mod process;
|
|
mod signature;
|
|
pub mod span;
|
|
mod syntax_shape;
|
|
mod ty;
|
|
mod value;
|
|
|
|
pub use alias::*;
|
|
pub use ast::Unit;
|
|
pub use config::*;
|
|
pub use did_you_mean::did_you_mean;
|
|
pub use engine::{ENV_VARIABLE_ID, IN_VARIABLE_ID, NU_VARIABLE_ID};
|
|
pub use errors::*;
|
|
pub use example::*;
|
|
pub use id::*;
|
|
pub use lev_distance::levenshtein_distance;
|
|
pub use module::*;
|
|
pub use pipeline::*;
|
|
#[cfg(feature = "plugin")]
|
|
pub use plugin::*;
|
|
pub use signature::*;
|
|
pub use span::*;
|
|
pub use syntax_shape::*;
|
|
pub use ty::*;
|
|
pub use value::*;
|