docs: improve convention for handling static mut slots
#5490
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.