Minor edits to ParseError
#908
Merged
Conversation
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
shaobo-he-aws
approved these changes
May 23, 2024
john-h-kastner-aws
approved these changes
May 23, 2024
cdisselkoen
approved these changes
May 23, 2024
Comment on lines
+671
to
674
| // Don't make fields `pub`, don't make breaking changes, and use caution when | ||
| // adding public methods. | ||
| #[derive(Clone, Debug, Default, PartialEq, Eq)] | ||
| pub struct ParseErrors(pub Vec<ParseError>); |
There was a problem hiding this comment.
"Don't make fields pub" is confusing when the type already has a pub field
There was a problem hiding this comment.
Maybe we should have this field be pub(crate) instead of pub, now that it's publically exported? Or should this type be an exception?
There was a problem hiding this comment.
Changed to pub(crate) in the latest commit. I plan to make the field private in a future PR.
There was a problem hiding this comment.
On second thought... undid this in the latest commit since I don't want to fix the resulting build failures. I promise that I'll take care of it in a PR in the next few days!
khieta
force-pushed
the
khieta/more-parse-err-nits
branch
from
4b6d64c to
871a800
Compare
cdisselkoen
approved these changes
May 23, 2024
3 tasks
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.
Description of changes
Another round of edits to the parsing-related errors. I expect to make more changes to the public API in a future PR (in particular: I think we want to better hide the terms "AST" and "CST" in the public API).
pub useforRestrictedExpressionParseErrorandParseError, which could previously be returned by public functions, but were never exported themselves 😅 Added "CAUTION" notes to these error types like the ones added in AlignEvaluationErrorandExtensionFunctionLookupErrorwith cedar#745 #860.ParseLiteralandRestrictedExprcases fromParseError.RestrictedExpr::from_str()andLiteral::from_str()now have their own error types.UnescapeErrors to not print theEscapeErrorvariant (which comes from Rust's lexer).Issue #, if available
Checklist for requesting a review
The change in this PR is (choose one, and delete the other options):
cedar-policy(e.g., changes to the signature of an existing API).(This PR will be batched with the other breaking changes that are part of #745.)
I confirm that this PR (choose one, and delete the other options):
I confirm that
cedar-spec(choose one, and delete the other options):