mirror of
https://github.com/nushell/nushell.git
synced 2024-11-25 09:53:43 +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>
58 lines
1.8 KiB
TOML
58 lines
1.8 KiB
TOML
[package]
|
|
authors = ["The Nushell Project Developers"]
|
|
description = "Nushell's internal protocols, including its abstract syntax tree"
|
|
repository = "https://github.com/nushell/nushell/tree/main/crates/nu-protocol"
|
|
edition = "2021"
|
|
license = "MIT"
|
|
name = "nu-protocol"
|
|
version = "0.93.1"
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
[lib]
|
|
bench = false
|
|
|
|
[dependencies]
|
|
nu-utils = { path = "../nu-utils", version = "0.93.1" }
|
|
nu-path = { path = "../nu-path", version = "0.93.1" }
|
|
nu-system = { path = "../nu-system", version = "0.93.1" }
|
|
|
|
brotli = { workspace = true, optional = true }
|
|
byte-unit = { version = "5.1", features = [ "serde" ] }
|
|
chrono = { workspace = true, features = [ "serde", "std", "unstable-locales" ], default-features = false }
|
|
chrono-humanize = { workspace = true }
|
|
fancy-regex = { workspace = true }
|
|
indexmap = { workspace = true }
|
|
lru = { workspace = true }
|
|
miette = { workspace = true, features = ["fancy-no-backtrace"] }
|
|
num-format = { workspace = true }
|
|
rmp-serde = { workspace = true, optional = true }
|
|
serde = { workspace = true, default-features = false }
|
|
serde_json = { workspace = true, optional = true }
|
|
thiserror = "1.0"
|
|
typetag = "0.2"
|
|
os_pipe = { workspace = true, features = ["io_safety"] }
|
|
|
|
[target.'cfg(unix)'.dependencies]
|
|
nix = { workspace = true, default-features = false, features = ["signal"] }
|
|
|
|
[features]
|
|
plugin = [
|
|
"brotli",
|
|
"rmp-serde",
|
|
"serde_json",
|
|
]
|
|
|
|
[dev-dependencies]
|
|
serde_json = { workspace = true }
|
|
strum = "0.26"
|
|
strum_macros = "0.26"
|
|
nu-test-support = { path = "../nu-test-support", version = "0.93.1" }
|
|
pretty_assertions = { workspace = true }
|
|
rstest = { workspace = true }
|
|
tempfile = { workspace = true }
|
|
os_pipe = { workspace = true }
|
|
|
|
[package.metadata.docs.rs]
|
|
all-features = true
|