mirror of
https://github.com/nushell/nushell.git
synced 2025-06-16 06:56:54 +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>
65 lines
1.8 KiB
Rust
65 lines
1.8 KiB
Rust
use std::process;
|
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
pub enum ExitStatus {
|
|
Exited(i32),
|
|
#[cfg(unix)]
|
|
Signaled {
|
|
signal: i32,
|
|
core_dumped: bool,
|
|
},
|
|
}
|
|
|
|
impl ExitStatus {
|
|
pub fn code(self) -> i32 {
|
|
match self {
|
|
ExitStatus::Exited(code) => code,
|
|
#[cfg(unix)]
|
|
ExitStatus::Signaled { signal, .. } => -signal,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
impl From<process::ExitStatus> for ExitStatus {
|
|
fn from(status: process::ExitStatus) -> Self {
|
|
use std::os::unix::process::ExitStatusExt;
|
|
|
|
match (status.code(), status.signal()) {
|
|
(Some(code), None) => Self::Exited(code),
|
|
(None, Some(signal)) => Self::Signaled {
|
|
signal,
|
|
core_dumped: status.core_dumped(),
|
|
},
|
|
(None, None) => {
|
|
debug_assert!(false, "ExitStatus should have either a code or a signal");
|
|
Self::Exited(-1)
|
|
}
|
|
(Some(code), Some(signal)) => {
|
|
// Should be unreachable, as `code()` will be `None` if `signal()` is `Some`
|
|
// according to the docs for `ExitStatus::code`.
|
|
debug_assert!(
|
|
false,
|
|
"ExitStatus cannot have both a code ({code}) and a signal ({signal})"
|
|
);
|
|
Self::Signaled {
|
|
signal,
|
|
core_dumped: status.core_dumped(),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(not(unix))]
|
|
impl From<process::ExitStatus> for ExitStatus {
|
|
fn from(status: process::ExitStatus) -> Self {
|
|
let code = status.code();
|
|
debug_assert!(
|
|
code.is_some(),
|
|
"`ExitStatus::code` cannot return `None` on windows"
|
|
);
|
|
Self::Exited(code.unwrap_or(-1))
|
|
}
|
|
}
|