improve usage of unsafe in gix-pack
#1233
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
Byron
force-pushed
the
unsafe-in-pack
branch
2 times, most recently
from
989c3de
to
50a82fb
Compare
Inspired by #1231 (comment) . - make sure the type in question isn't use outside of its designated module - improve documentation around safety to make the underlying data structure more obvious.
Manishearth
reviewed
Jan 4, 2024
| @@ -68,7 +71,7 @@ mod node { | |||
| } | |||
| } | |||
|
|
|||
| pub(crate) struct State<'items, F, MBFN, T: Send> { | |||
| pub(in crate::cache::delta::traverse) struct State<'items, F, MBFN, T: Send> { | |||
There was a problem hiding this comment.
I think you can do pub(super)?
There was a problem hiding this comment.
I also think the invariant should be mentioned on the fields that have them.
There was a problem hiding this comment.
and it's those fields that should be visibility restricted
There was a problem hiding this comment.
Thanks a lot, I tried to apply this feedback in 696cbb8 (shoehorned into my current feature-PR).
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.
Inspired by #1231 (comment) .
more obvious.