mirror of
https://github.com/nushell/nushell.git
synced 2024-12-12 02:02:32 +01:00
c61075e20e
# Description
This PR allows byte streams to optionally be colored as being
specifically binary or string data, which guarantees that they'll be
converted to `Binary` or `String` appropriately on `into_value()`,
making them compatible with `Type` guarantees. This makes them
significantly more broadly usable for command input and output.
There is still an `Unknown` type for byte streams coming from external
commands, which uses the same behavior as we previously did where it's a
string if it's UTF-8.
A small number of commands were updated to take advantage of this, just
to prove the point. I will be adding more after this merges.
# User-Facing Changes
- New types in `describe`: `string (stream)`, `binary (stream)`
- These commands now return a stream if their input was a stream:
- `into binary`
- `into string`
- `bytes collect`
- `str join`
- `first` (binary)
- `last` (binary)
- `take` (binary)
- `skip` (binary)
- Streams that are explicitly binary colored will print as a streaming
hexdump
- example:
```nushell
1.. | each { into binary } | bytes collect
```
# Tests + Formatting
I've added some tests to cover it at a basic level, and it doesn't break
anything existing, but I do think more would be nice. Some of those will
come when I modify more commands to stream.
# After Submitting
There are a few things I'm not quite satisfied with:
- **String trimming behavior.** We automatically trim newlines from
streams from external commands, but I don't think we should do this with
internal commands. If I call a command that happens to turn my string
into a stream, I don't want the newline to suddenly disappear. I changed
this to specifically do it only on `Child` and `File`, but I don't know
if this is quite right, and maybe we should bring back the old flag for
`trim_end_newline`
- **Known binary always resulting in a hexdump.** It would be nice to
have a `print --raw`, so that we can put binary data on stdout
explicitly if we want to. This PR doesn't change how external commands
work though - they still dump straight to stdout.
Otherwise, here's the normal checklist:
- [ ] release notes
- [ ] docs update for plugin protocol changes (added `type` field)
---------
Co-authored-by: Ian Manske <ian.manske@pm.me>
28 lines
583 B
Rust
28 lines
583 B
Rust
use nu_test_support::{nu, pipeline};
|
|
|
|
#[test]
|
|
fn test_stream() {
|
|
let actual = nu!(pipeline(
|
|
"
|
|
[0x[01] 0x[02] 0x[03] 0x[04]]
|
|
| filter {true}
|
|
| bytes collect 0x[aa aa]
|
|
| encode hex
|
|
"
|
|
));
|
|
assert_eq!(actual.out, "01AAAA02AAAA03AAAA04");
|
|
}
|
|
|
|
#[test]
|
|
fn test_stream_type() {
|
|
let actual = nu!(pipeline(
|
|
"
|
|
[0x[01] 0x[02] 0x[03] 0x[04]]
|
|
| filter {true}
|
|
| bytes collect 0x[00]
|
|
| describe -n
|
|
"
|
|
));
|
|
assert_eq!(actual.out, "binary (stream)");
|
|
}
|