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>
99 lines
3.3 KiB
Rust
99 lines
3.3 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use nu_protocol::OutDest;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Complete;
|
|
|
|
impl Command for Complete {
|
|
fn name(&self) -> &str {
|
|
"complete"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("complete")
|
|
.category(Category::System)
|
|
.input_output_types(vec![(Type::Any, Type::record())])
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Capture the outputs and exit code from an external piped in command in a nushell table."
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
r#"In order to capture stdout, stderr, and exit_code, externally piped in commands need to be wrapped with `do`"#
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
match input {
|
|
PipelineData::ByteStream(stream, ..) => {
|
|
let Ok(child) = stream.into_child() else {
|
|
return Err(ShellError::GenericError {
|
|
error: "Complete only works with external commands".into(),
|
|
msg: "complete only works on external commands".into(),
|
|
span: Some(call.head),
|
|
help: None,
|
|
inner: vec![],
|
|
});
|
|
};
|
|
|
|
let output = child.wait_with_output()?;
|
|
let exit_code = output.exit_status.code();
|
|
let mut record = Record::new();
|
|
|
|
if let Some(stdout) = output.stdout {
|
|
record.push(
|
|
"stdout",
|
|
match String::from_utf8(stdout) {
|
|
Ok(str) => Value::string(str, head),
|
|
Err(err) => Value::binary(err.into_bytes(), head),
|
|
},
|
|
);
|
|
}
|
|
|
|
if let Some(stderr) = output.stderr {
|
|
record.push(
|
|
"stderr",
|
|
match String::from_utf8(stderr) {
|
|
Ok(str) => Value::string(str, head),
|
|
Err(err) => Value::binary(err.into_bytes(), head),
|
|
},
|
|
);
|
|
}
|
|
|
|
record.push("exit_code", Value::int(exit_code.into(), head));
|
|
|
|
Ok(Value::record(record, call.head).into_pipeline_data())
|
|
}
|
|
// bubble up errors from the previous command
|
|
PipelineData::Value(Value::Error { error, .. }, _) => Err(*error),
|
|
_ => Err(ShellError::GenericError {
|
|
error: "Complete only works with external commands".into(),
|
|
msg: "complete only works on external commands".into(),
|
|
span: Some(head),
|
|
help: None,
|
|
inner: vec![],
|
|
}),
|
|
}
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description:
|
|
"Run the external command to completion, capturing stdout, stderr, and exit_code",
|
|
example: "^external arg1 | complete",
|
|
result: None,
|
|
}]
|
|
}
|
|
|
|
fn pipe_redirection(&self) -> (Option<OutDest>, Option<OutDest>) {
|
|
(Some(OutDest::Capture), Some(OutDest::Capture))
|
|
}
|
|
}
|