.cargo

.githooks

.github

assets

benches

clippy

crates

nu-cli

nu-cmd-base

nu-cmd-extra

nu-cmd-lang

nu-cmd-plugin

nu-color-config

nu-command

src

tests

commands

assignment

base

bytes

conversions

database

date

debug

hash_

math

move_

network

path

platform

query

random

skip

str_

take

mod.rs

rows.rs

until.rs

while_.rs

url

alias.rs

all.rs

any.rs

append.rs

break_.rs

cal.rs

cd.rs

chunk_by.rs

chunks.rs

compact.rs

complete.rs

config_env_default.rs

config_nu_default.rs

continue_.rs

debug_info.rs

def.rs

default.rs

detect_columns.rs

do_.rs

drop.rs

du.rs

each.rs

echo.rs

empty.rs

error_make.rs

every.rs

exec.rs

export_def.rs

fill.rs

filter.rs

find.rs

first.rs

flatten.rs

for_.rs

format.rs

generate.rs

get.rs

glob.rs

griddle.rs

group_by.rs

headers.rs

help.rs

histogram.rs

ignore.rs

insert.rs

inspect.rs

interleave.rs

into_datetime.rs

into_duration.rs

into_filesize.rs

into_int.rs

job.rs

join.rs

last.rs

length.rs

let_.rs

lines.rs

loop_.rs

ls.rs

match_.rs

merge.rs

merge_deep.rs

mktemp.rs

mod.rs

mut_.rs

nu_check.rs

open.rs

par_each.rs

parse.rs

prepend.rs

print.rs

redirection.rs

reduce.rs

reject.rs

rename.rs

return_.rs

reverse.rs

rm.rs

roll.rs

rotate.rs

run_external.rs

save.rs

select.rs

semicolon.rs

seq.rs

seq_char.rs

seq_date.rs

slice.rs

sort.rs

sort_by.rs

source_env.rs

split_column.rs

split_row.rs

start.rs

stor.rs

table.rs

tee.rs

terminal.rs

to_text.rs

transpose.rs

try_.rs

ucp.rs

ulimit.rs

umkdir.rs

uname.rs

uniq.rs

uniq_by.rs

update.rs

upsert.rs

use_.rs

utouch.rs

where_.rs

which.rs

while_.rs

window.rs

with_env.rs

wrap.rs

zip.rs

format_conversions

string

main.rs

sort_utils.rs

Cargo.toml

LICENSE

README.md

nu-derive-value

nu-engine

nu-experimental

nu-explore

nu-glob

nu-json

nu-lsp

nu-parser

nu-path

nu-plugin

nu-plugin-core

nu-plugin-engine

nu-plugin-protocol

nu-plugin-test-support

nu-pretty-hex

nu-protocol

nu-std

nu-system

nu-table

nu-term-grid

nu-test-support

nu-utils

nu_plugin_custom_values

nu_plugin_example

nu_plugin_formats

nu_plugin_gstat

nu_plugin_inc

nu_plugin_javascript

nu_plugin_nu_example

nu_plugin_polars

nu_plugin_python

nu_plugin_query

nu_plugin_stress_internals

nuon

README.md

devdocs

docker

scripts

src

tests

wix

.gitattributes

.gitignore

CITATION.cff

CODE_OF_CONDUCT.md

CONTRIBUTING.md

Cargo.lock

Cargo.toml

Cross.toml

LICENSE

README.md

SECURITY.md

rust-toolchain.toml

toolkit.nu

typos.toml

Devyn Cairns c61075e20e Add string/binary type color to ByteStream (#12897) ...

# 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>

2024-05-20 00:35:32 +00:00

..

mod.rs

Move 'keep' to 'take' (#5123)

2022-04-08 08:49:28 +12:00

rows.rs

Add string/binary type color to ByteStream (#12897)

2024-05-20 00:35:32 +00:00

until.rs

Remove file I/O from tests that don't need it (#11182)

2023-11-29 23:21:34 +01:00

while_.rs

Remove file I/O from tests that don't need it (#11182)

2023-11-29 23:21:34 +01:00