nushell/crates/nu-command/src/system
Ian Manske 8da27a1a09
Create Record type (#10103)
# 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}`.
2023-08-25 07:50:29 +12:00
..
complete.rs Create Record type (#10103) 2023-08-25 07:50:29 +12:00
exec.rs Add --redirect-combine option to run-external (#8918) 2023-04-28 07:55:48 -05:00
mod.rs relocate debug commands (#8071) 2023-02-13 16:39:07 +00:00
nu_check.rs Add functions for each Value case (#9736) 2023-07-21 08:20:33 -05:00
ps.rs Create Record type (#10103) 2023-08-25 07:50:29 +12:00
registry_query.rs Create Record type (#10103) 2023-08-25 07:50:29 +12:00
run_external.rs Rename misused "deprecation" to removal (#10000) 2023-08-15 07:17:31 +12:00
sys.rs Create Record type (#10103) 2023-08-25 07:50:29 +12:00
which_.rs Create Record type (#10103) 2023-08-25 07:50:29 +12:00