nushell/crates
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
..
nu_plugin_custom_values bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu_plugin_example Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu_plugin_formats Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu_plugin_gstat Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu_plugin_inc bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu_plugin_python remove vectorize_over_list from python plugin (#9905) 2023-08-03 16:46:48 +02:00
nu_plugin_query Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-cli Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-cmd-base Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-cmd-dataframe Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-cmd-extra Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-cmd-lang Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-color-config Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-command Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-engine Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-explore Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-glob bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-json bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-parser Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-path bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-plugin bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-pretty-hex bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-protocol Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-std bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-system bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-table Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-term-grid bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-test-support bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-utils bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
README.md

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.