-
Notifications
You must be signed in to change notification settings - Fork 138
Introduce ProjectField trait
#2886
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @jswrenn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request introduces a new unsafe trait ProjectField to facilitate invariant-respecting projections over Ptrs. The new trait is well-defined and documented. My review includes a suggestion to correct a minor inconsistency in the documentation for the project method, where the parameter name used in the comments differs from the one in the function signature. Aligning these will improve clarity, which is crucial for an unsafe trait.
src/lib.rs
Outdated
| /// Projects from `slf` to the field. | ||
| /// | ||
| /// # Safety | ||
| /// | ||
| /// The returned pointer refers to a non-strict subset of the bytes of | ||
| /// `slf`'s referent, and has the same provenance as `slf`. |
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 documentation for project refers to a parameter named slf, but the actual parameter is named ptr. To avoid confusion, especially in a safety-critical unsafe trait, the documentation should be updated to use the correct parameter name ptr.
/// Projects from `ptr` to the field.
///
/// # Safety
///
/// The returned pointer refers to a non-strict subset of the bytes of
/// `ptr`'s referent, and has the same provenance as `ptr`.
7261c75 to
30859f4
Compare
bb6f84e to
c6f7382
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## G90165d85418ed6203ef3caaa77662dd3b313e030 #2886 +/- ##
=============================================================================
- Coverage 91.82% 91.41% -0.41%
=============================================================================
Files 20 20
Lines 5883 5909 +26
=============================================================================
Hits 5402 5402
- Misses 481 507 +26 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
c6f7382 to
dc4cfc8
Compare
c37d1c9 to
105108b
Compare
|
|
||
| /// TODO | ||
| // SAFETY: Struct and union projection is infallible. | ||
| fn is_projectable<'a>(ptr: Ptr<'a, Self, I>) -> Result<Ptr<'a, Self, I>, Self::Error> { |
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.
| fn is_projectable<'a>(ptr: Ptr<'a, Self, I>) -> Result<Ptr<'a, Self, I>, Self::Error> { | |
| #[inline(always)] | |
| fn is_projectable<'a>(ptr: Ptr<'a, Self, I>) -> Result<Ptr<'a, Self, I>, Self::Error> { |
src/lib.rs
Outdated
| /// TODO | ||
| // SAFETY: Struct and union projection is infallible. |
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.
Also TODO: Docs should mention that implementers MUST override this for enum types.
dc4cfc8 to
dbdce80
Compare
4c71ea4 to
7850e9f
Compare
dbdce80 to
16c5cd9
Compare
This trait powers invariant-respecting projection over `Ptr`s. gherrit-pr-id: Gb6fa34cec5080caffa0980ed1d3e1ae273550f44
7850e9f to
d48e645
Compare
This trait powers invariant-respecting projection over
Ptrs.ProjectFieldtrait #2886Latest Update: v7 — Compare vs v6
📚 Full Patch History
Links show the diff between the row version and the column version.