Adds step_in and step_out to the text reader
#332
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Removes non-value variants from the `TextStreamItem` enum, including `ListEnd`, `SExpressionEnd`, `StructEnd`, `Comment`, and `EndOfStream`. * Adds container item parsing rules that return a `None` if an end-of-container delimiter is found instead of a value. * Adds methods to the reader for parsing container values. These methods will eventually be private helper methods called by `next()`. For the moment, users must call them manually. * Makes the `parse_test_ok` and `parse_test_err` unit test helper methods generic, allowing them to be used in more places. Fixes #328.
* Now that `TextStreamItem` only represents Ion values (and not comments, container ends, or EOF), it has been renamed to `TextValue`. * The pervasive tuple type `(Vec<OwnedSymbolToken>, TextStreamItem)` has been replaced by an `AnnotatedTextValue` struct that combines a `TextValue` with an `Vec<OwnedSymbolToken>`. It also provides helper methods for construction and conversions. * Several parser names have been simplified by removing `recognize_` and `parse_` as prefixes. This is part of the work needed to address #327. * Replaced `stream item` in variable/method names with `value`. Fixes #330.
* Creates a new type, `ParentContainer`, to represent levels of depth in the data. * Adds `step_in`, `step_out`, and `field_name` methods that can be used to traverse text Ion data of any shape. * Adds logic to skip over the rest of a container as needed when `next` and `step_out` are called.
desaikd
approved these changes
Oct 13, 2021
Will do! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This depends on the changes in PR #331. When 331 is merged, this PR will be rebased against it.
Changes:
ParentContainer, to represent levels ofdepth in the data.
step_in,step_out, andfield_namemethods that canbe used to traverse text Ion data of any shape.
nextandstep_outare called.A future PR will modify the reader so it implements the
Cursortrait (i.e. system reader). This means thatnext()will no longer return anAnnotatedTextValue(which will be a private type); it will instead return anIonTypeindicating what was found in the stream. Users can then call functions likeread_i64to get at the values themselves.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.