docs: improve convention for handling static mut slots#5490
Merged
docs: improve convention for handling static mut slots#5490
static mut slots#5490Conversation
Icxolu
approved these changes
Oct 4, 2025
Member
Icxolu
left a comment
There was a problem hiding this comment.
I was having similar thoughts when I saw that failure yesterday. I think using an array here is much more appropriate and less sketchy. Having to type out the length is a bit annoying, but still quite readable I would say.
Member
Author
|
Hmm annoyingly this looks like another thing blocked on #5486 |
Member
|
That's unfortunate... I guess it's the reason we had the reference in there to begin with. |
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
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.
While considering CI failures in #5481 I realised our way of defining static "slots" is potentially questionable.
&immutable reference in the static, which seems questionable given the intent is to express mutable data. We cast this away using pointer casting.unsafeblock. Reading the value of mutable statics is known to be full of footguns.The cleanest way I could find to do this, as proposed in this PR, is to store the mutable static as a
static mut [T; N]array. It requires specifyingN, because the compiler does not allow inference of the array size.The nice thing about storing slots as an array is that we can then get a pointer to its first element with
addr_of_mut!(SLOTS).cast(), which avoids anyunsafeblock or reading the value of the static.