mirror of
https://github.com/nushell/nushell.git
synced 2025-05-20 14:43:22 +00: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>
36 lines
959 B
Rust
36 lines
959 B
Rust
use nu_plugin::{Plugin, PluginCommand};
|
|
|
|
mod commands;
|
|
mod example;
|
|
|
|
pub use commands::*;
|
|
pub use example::ExamplePlugin;
|
|
|
|
impl Plugin for ExamplePlugin {
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
// This is a list of all of the commands you would like Nu to register when your plugin is
|
|
// loaded.
|
|
//
|
|
// If it doesn't appear on this list, it won't be added.
|
|
vec![
|
|
Box::new(Main),
|
|
// Basic demos
|
|
Box::new(One),
|
|
Box::new(Two),
|
|
Box::new(Three),
|
|
// Engine interface demos
|
|
Box::new(Config),
|
|
Box::new(Env),
|
|
Box::new(ViewSpan),
|
|
Box::new(DisableGc),
|
|
// Stream demos
|
|
Box::new(CollectBytes),
|
|
Box::new(Echo),
|
|
Box::new(ForEach),
|
|
Box::new(Generate),
|
|
Box::new(Seq),
|
|
Box::new(Sum),
|
|
]
|
|
}
|
|
}
|