forked from extern/nushell
c87bac04c0
# Description > Our `Record` looks like a map, quacks like a map, so let's treat it with the API for a map Implement common methods found on e.g. `std::collections::HashMap` or the insertion-ordered [indexmap](https://docs.rs/indexmap). This allows contributors to not have to worry about how to get to the relevant items and not mess up the assumptions of a Nushell record. ## Record assumptions - `cols` and `vals` are of equal length - for all practical purposes, keys/columns should be unique ## End goal The end goal of the upcoming series of PR's is to allow us to make `cols` and `vals` private. Then it would be possible to exchange the backing datastructure to best fit the expected workload. This could be statically (by finding the best balance) or dynamically by using an `enum` of potential representations. ## Parts - Add validating explicit part constructor `Record::from_raw_cols_vals()` - Add `Record.columns()` iterator - Add `Record.values()` iterator - Add consuming `Record.into_values()` iterator - Add `Record.contains()` helper - Add `Record.insert()` that respects existing keys - Add key-based `.get()`/`.get_mut()` to `Record` - Add `Record.get_index()` for index-based access - Implement `Extend` for `Record` naively - Use checked constructor in `record!` macro - Add `Record.index_of()` to get index by key # User-Facing Changes None directly # Developer facing changes You don't have to roll your own record handling and can use a familiar API # Tests + Formatting No explicit unit tests yet. Wouldn't be too tricky to validate core properties directly. Will be exercised by the following PRs using the new methods/traits/iterators. |
||
|---|---|---|
| .. | ||
| ast | ||
| engine | ||
| value | ||
| alias.rs | ||
| cli_error.rs | ||
| config.rs | ||
| did_you_mean.rs | ||
| eval_const.rs | ||
| example.rs | ||
| exportable.rs | ||
| id.rs | ||
| lev_distance.rs | ||
| lib.rs | ||
| module.rs | ||
| parse_error.rs | ||
| pipeline_data.rs | ||
| plugin_signature.rs | ||
| shell_error.rs | ||
| signature.rs | ||
| span.rs | ||
| syntax_shape.rs | ||
| ty.rs | ||
| util.rs | ||
| variable.rs | ||