Recursive macro expansion in TDL containers #647
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,35 +35,45 @@ where | |
| type MacroInvocation: MacroInvocation<'data, Self>; | ||
| } | ||
|
|
||
| /// An expression found in value position in either serialized Ion or a template. | ||
| /// If it is a value literal, it is considered a stream with exactly one Ion value. | ||
| /// If it is a macro invocation, it is a stream with zero or more Ion values. | ||
| #[derive(Copy, Clone, Debug)] | ||
| pub enum RawValueExpr<V, M> { | ||
| /// A value literal. For example: `5`, `foo`, or `"hello"` in text. | ||
| ValueLiteral(V), | ||
| /// An Ion 1.1+ macro invocation. For example: `(:employee 12345 "Sarah" "Gonzalez")` in text. | ||
| MacroInvocation(M), | ||
| } | ||
|
|
||
| // `RawValueExpr` above has no ties to a particular encoding. The `LazyRawValueExpr` type alias | ||
| // below uses the `Value` and `MacroInvocation` associated types from the decoder `D`. In most | ||
| // places, this is a helpful constraint; we can talk about the value expression in terms of the | ||
| // LazyDecoder it's associated with. However, in some places (primarily when expanding template | ||
| // values that don't have a LazyDecoder) we need to be able to use it without constraints. | ||
|
Comment on lines
+49
to
+53
There was a problem hiding this comment. This should be moved to the doc comments of one or both of There was a problem hiding this comment. Good call, I'll add this to #652. |
||
|
|
||
| /// An item found in value position within an Ion data stream written in the encoding represented | ||
| /// by the LazyDecoder `D`. This item may be either a value literal or a macro invocation. | ||
| pub type LazyRawValueExpr<'data, D> = | ||
| RawValueExpr<<D as LazyDecoder<'data>>::Value, <D as LazyDecoder<'data>>::MacroInvocation>; | ||
|
|
||
| impl<V: Debug, M: Debug> RawValueExpr<V, M> { | ||
| pub fn expect_value(self) -> IonResult<V> { | ||
| match self { | ||
| RawValueExpr::ValueLiteral(v) => Ok(v), | ||
| RawValueExpr::MacroInvocation(_m) => IonResult::decoding_error( | ||
| "expected a value literal, but found a macro invocation ({:?})", | ||
| ), | ||
| } | ||
| } | ||
|
|
||
| pub fn expect_macro(self) -> IonResult<M> { | ||
| match self { | ||
| RawValueExpr::ValueLiteral(v) => IonResult::decoding_error(format!( | ||
| "expected a macro invocation but found a value literal ({:?})", | ||
| v | ||
| )), | ||
| RawValueExpr::MacroInvocation(m) => Ok(m), | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -74,15 +84,27 @@ impl<'data, D: LazyDecoder<'data>> LazyRawValueExpr<'data, D> { | |
| /// * a name/e-expression pair | ||
| /// * an e-expression | ||
| #[derive(Debug)] | ||
| pub enum RawFieldExpr<'name, V, M> { | ||
| NameValuePair(RawSymbolTokenRef<'name>, RawValueExpr<V, M>), | ||
| MacroInvocation(M), | ||
| } | ||
|
|
||
| // As with the `RawValueExpr`/`LazyRawValueExpr` type pair, a `RawFieldExpr` has no constraints | ||
| // on the types used for values or macros, while the `LazyRawFieldExpr` type alias below uses the | ||
| // value and macro types associated with the decoder `D`. | ||
|
|
||
| /// An item found in struct field position an Ion data stream written in the encoding represented | ||
| /// by the LazyDecoder `D`. | ||
| pub type LazyRawFieldExpr<'data, D> = RawFieldExpr< | ||
| 'data, | ||
| <D as LazyDecoder<'data>>::Value, | ||
| <D as LazyDecoder<'data>>::MacroInvocation, | ||
| >; | ||
|
|
||
| impl<'name, V: Debug, M: Debug> RawFieldExpr<'name, V, M> { | ||
| pub fn expect_name_value(self) -> IonResult<(RawSymbolTokenRef<'name>, V)> { | ||
| match self { | ||
| RawFieldExpr::NameValuePair(name, RawValueExpr::ValueLiteral(value)) => { | ||
| Ok((name, value)) | ||
| } | ||
| _ => IonResult::decoding_error(format!( | ||
|
|
@@ -92,22 +114,21 @@ impl<'data, D: LazyDecoder<'data>> LazyRawFieldExpr<'data, D> { | |
| } | ||
| } | ||
|
|
||
| pub fn expect_name_macro(self) -> IonResult<(RawSymbolTokenRef<'name>, M)> { | ||
| match self { | ||
| RawFieldExpr::NameValuePair(name, RawValueExpr::MacroInvocation(invocation)) => { | ||
| Ok((name, invocation)) | ||
| } | ||
| _ => IonResult::decoding_error(format!( | ||
| "expected a name/macro pair but found {:?}", | ||
| self | ||
| )), | ||
| } | ||
| } | ||
|
|
||
| pub fn expect_macro(self) -> IonResult<M> { | ||
| match self { | ||
| RawFieldExpr::MacroInvocation(invocation) => Ok(invocation), | ||
| _ => IonResult::decoding_error(format!( | ||
| "expected a macro invocation but found {:?}", | ||
| self | ||
|
|
@@ -125,6 +146,7 @@ impl<'data, D: LazyDecoder<'data>> LazyRawFieldExpr<'data, D> { | |
| // internal code that is defined in terms of `LazyRawField` to call the private `into_value()` | ||
| // function while also preventing users from seeing or depending on it. | ||
| pub(crate) mod private { | ||
| use crate::lazy::encoding::RawValueLiteral; | ||
| use crate::{IonResult, RawSymbolTokenRef}; | ||
|
|
||
| use super::LazyDecoder; | ||
|
|
@@ -143,7 +165,7 @@ pub(crate) mod private { | |
| fn from_value(value: D::Value) -> Self; | ||
| } | ||
|
|
||
| pub trait LazyRawValuePrivate<'data>: RawValueLiteral { | ||
| /// Returns the field name associated with this value. If the value is not inside a struct, | ||
| /// returns `IllegalOperation`. | ||
| fn field_name(&self) -> IonResult<RawSymbolTokenRef<'data>>; | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🗺️ The enum
LazyRawValueExpr<'data, D>can be either a value literal (D::Value) or a macro invocation (D::MacroInvocation). Starting with this PR, we needed the ability to talk about value expressions that might have come from templates, which are not a kind of stream encoding and so do not have a corresponding implementationD: LazyDecoder<'data>.The new enum
RawValueExpr<V, M>allows any types to be used as the value (V) and the macro invocation (M).LazyRawValueExpr<'data, D>is now a type alias for the most common kind of value expression:An analogous change has been made for the
LazyRawFieldExpr/RawFieldExprpair.