[doc] Document rustc type privacy bug #1734
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
jswrenn
force-pushed
the
doc-privacy-issue
branch
from
d0c816e
to
c5caa45
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1734 +/- ##
=======================================
Coverage 88.11% 88.11%
=======================================
Files 16 16
Lines 5720 5720
=======================================
Hits 5040 5040
Misses 680 680 ☔ View full report in Codecov by Sentry. |
joshlf
requested changes
Sep 23, 2024
src/lib.rs
Outdated
| /// = note: this error originates in the derive macro `KnownLayout` (in Nightly builds, run with -Z macro-backtrace for more info) | ||
| /// ``` | ||
| /// | ||
| /// To work around this bug, mark private field types as `pub` and annotate them with `#[doc(hidden)]`. |
There was a problem hiding this comment.
This is only required under some circumstances. I'd double check the KnownLayout derive to get the exact list, but off the top of my head:
- It only applies to the trailing field, so I'd update the example to have two fields
- There is no separate trailing field type if it's generic (ie, if its type is
TwhereTis a type parameter - this doesn't apply for, egFoo<T>, sinceFoocould still be a private type) - There might be reprs for which this isn't a problem? Idr.
jswrenn
force-pushed
the
doc-privacy-issue
branch
2 times, most recently
from
4cf65c0
to
8a56a12
Compare
joshlf
approved these changes
Sep 23, 2024
jswrenn
force-pushed
the
doc-privacy-issue
branch
from
8a56a12
to
3777e46
Compare
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.
See #1292
Makes progress towards #671