forked from extern/nushell
8da27a1a09
# Description
This PR creates a new `Record` type to reduce duplicate code and
possibly bugs as well. (This is an edited version of #9648.)
- `Record` implements `FromIterator` and `IntoIterator` and so can be
iterated over or collected into. For example, this helps with
conversions to and from (hash)maps. (Also, no more
`cols.iter().zip(vals)`!)
- `Record` has a `push(col, val)` function to help insure that the
number of columns is equal to the number of values. I caught a few
potential bugs thanks to this (e.g. in the `ls` command).
- Finally, this PR also adds a `record!` macro that helps simplify
record creation. It is used like so:
```rust
record! {
"key1" => some_value,
"key2" => Value::string("text", span),
"key3" => Value::int(optional_int.unwrap_or(0), span),
"key4" => Value::bool(config.setting, span),
}
```
Since macros hinder formatting, etc., the right hand side values should
be relatively short and sweet like the examples above.
Where possible, prefer `record!` or `.collect()` on an iterator instead
of multiple `Record::push`s, since the first two automatically set the
record capacity and do less work overall.
# User-Facing Changes
Besides the changes in `nu-protocol` the only other breaking changes are
to `nu-table::{ExpandedTable::build_map, JustTable::kv_table}`.
65 lines
1.8 KiB
Rust
65 lines
1.8 KiB
Rust
use chrono_tz::TZ_VARIANTS;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
record, Category, Example, IntoInterruptiblePipelineData, PipelineData, Record, ShellError,
|
|
Signature, Span, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"date list-timezone"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("date list-timezone")
|
|
.input_output_types(vec![(Type::Nothing, Type::Table(vec![]))])
|
|
.category(Category::Date)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"List supported time zones."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["UTC", "GMT", "tz"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let span = call.head;
|
|
|
|
Ok(TZ_VARIANTS
|
|
.iter()
|
|
.map(move |x| {
|
|
Value::record(
|
|
record! { "timezone" => Value::string(x.name(), span) },
|
|
span,
|
|
)
|
|
})
|
|
.into_pipeline_data(engine_state.ctrlc.clone()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "date list-timezone | where timezone =~ Shanghai",
|
|
description: "Show timezone(s) that contains 'Shanghai'",
|
|
result: Some(Value::List {
|
|
vals: vec![Value::test_record(Record {
|
|
cols: vec!["timezone".into()],
|
|
vals: vec![Value::test_string("Asia/Shanghai")],
|
|
})],
|
|
span: Span::test_data(),
|
|
}),
|
|
}]
|
|
}
|
|
}
|