mirror of
https://github.com/nushell/nushell.git
synced 2024-12-12 18:20:55 +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>
61 lines
1.3 KiB
Rust
61 lines
1.3 KiB
Rust
use nu_test_support::{nu, pipeline};
|
|
|
|
#[test]
|
|
fn rows() {
|
|
let sample = r#"
|
|
[[name, lucky_code];
|
|
[Andrés, 1],
|
|
[JT , 1],
|
|
[Jason , 2],
|
|
[Yehuda, 1]]"#;
|
|
|
|
let actual = nu!(pipeline(&format!(
|
|
r#"
|
|
{sample}
|
|
| take 3
|
|
| get lucky_code
|
|
| math sum
|
|
"#
|
|
)));
|
|
|
|
assert_eq!(actual.out, "4");
|
|
}
|
|
|
|
#[test]
|
|
fn rows_with_no_arguments_should_lead_to_error() {
|
|
let actual = nu!("[1 2 3] | take");
|
|
|
|
assert!(actual.err.contains("missing_positional"));
|
|
}
|
|
|
|
#[test]
|
|
fn fails_on_string() {
|
|
let actual = nu!(r#""foo bar" | take 2"#);
|
|
|
|
assert!(actual.err.contains("command doesn't support"));
|
|
}
|
|
|
|
#[test]
|
|
fn takes_bytes() {
|
|
let actual = nu!("(0x[aa bb cc] | take 2) == 0x[aa bb]");
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn takes_bytes_from_stream() {
|
|
let actual = nu!("(1.. | each { 0x[aa bb cc] } | bytes collect | take 2) == 0x[aa bb]");
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
// covers a situation where `take` used to behave strangely on list<binary> input
|
|
fn works_with_binary_list() {
|
|
let actual = nu!(r#"
|
|
([0x[01 11]] | take 1 | get 0) == 0x[01 11]
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|