mirror of
https://github.com/nushell/nushell.git
synced 2025-05-15 23:44:36 +02:00
7de513a4e0
# Description Implements streaming for: - `from csv` - `from tsv` - `to csv` - `to tsv` via the new string-typed ByteStream support. # User-Facing Changes Commands above. Also: - `to csv` and `to tsv` now have `--columns <List(String)>`, to provide the exact columns desired in the output. This is required for them to have streaming output, because otherwise collecting the entire list is necessary to determine the output columns. If we introduce `TableStream`, this may become less necessary. # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting - [ ] release notes --------- Co-authored-by: Ian Manske <ian.manske@pm.me>
99 lines
2.7 KiB
Rust
99 lines
2.7 KiB
Rust
use std::sync::Arc;
|
|
|
|
use crate::formats::to::delimited::to_delimited_data;
|
|
use nu_engine::command_prelude::*;
|
|
use nu_protocol::Config;
|
|
|
|
#[derive(Clone)]
|
|
pub struct ToTsv;
|
|
|
|
impl Command for ToTsv {
|
|
fn name(&self) -> &str {
|
|
"to tsv"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("to tsv")
|
|
.input_output_types(vec![
|
|
(Type::record(), Type::String),
|
|
(Type::table(), Type::String),
|
|
])
|
|
.switch(
|
|
"noheaders",
|
|
"do not output the column names as the first row",
|
|
Some('n'),
|
|
)
|
|
.named(
|
|
"columns",
|
|
SyntaxShape::List(SyntaxShape::String.into()),
|
|
"the names (in order) of the columns to use",
|
|
None,
|
|
)
|
|
.category(Category::Formats)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Convert table into .tsv text."
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Outputs a TSV string representing the contents of this table",
|
|
example: "[[foo bar]; [1 2]] | to tsv",
|
|
result: Some(Value::test_string("foo\tbar\n1\t2\n")),
|
|
},
|
|
Example {
|
|
description: "Outputs a TSV string representing the contents of this record",
|
|
example: "{a: 1 b: 2} | to tsv",
|
|
result: Some(Value::test_string("a\tb\n1\t2\n")),
|
|
},
|
|
Example {
|
|
description: "Outputs a TSV stream with column names pre-determined",
|
|
example: "[[foo bar baz]; [1 2 3]] | to tsv --columns [baz foo]",
|
|
result: Some(Value::test_string("baz\tfoo\n3\t1\n")),
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let noheaders = call.has_flag(engine_state, stack, "noheaders")?;
|
|
let columns: Option<Vec<String>> = call.get_flag(engine_state, stack, "columns")?;
|
|
let config = engine_state.config.clone();
|
|
to_tsv(input, noheaders, columns, head, config)
|
|
}
|
|
}
|
|
|
|
fn to_tsv(
|
|
input: PipelineData,
|
|
noheaders: bool,
|
|
columns: Option<Vec<String>>,
|
|
head: Span,
|
|
config: Arc<Config>,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let sep = Spanned {
|
|
item: '\t',
|
|
span: head,
|
|
};
|
|
to_delimited_data(noheaders, sep, columns, "TSV", input, head, config)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(ToTsv {})
|
|
}
|
|
}
|