Skip to content

Commit 81ea610

Browse files
authored
Rollup merge of #95583 - scottmcm:deprecate-ptr-to-from-bits, r=dtolnay
Deprecate the unstable `ptr_to_from_bits` feature I propose that we deprecate the (unstable!) `to_bits` and `from_bits` methods on raw pointers. (With the intent to ~~remove them once `addr` has been around long enough to make the transition easy on people -- maybe another 6 weeks~~ remove them fairly soon after, as the strict and expose versions have been around for a while already.) The APIs that came from the strict provenance explorations (#95228) are a more holistic version of these, and things like `.expose_addr()` work for the "that cast looks sketchy" case even if the full strict provenance stuff never happens. (As a bonus, `addr` is even shorter than `to_bits`, though it is only applicable if people can use full strict provenance! `addr` is *not* a direct replacement for `to_bits`.) So I think it's fine to move away from the `{to|from}_bits` methods, and encourage the others instead. That also resolves the worry that was brought up (I forget where) that `q.to_bits()` and `(*q).to_bits()` both work if `q` is a pointer-to-floating-point, as they also have a `to_bits` method. Tracking issue #91126 Code search: https://github.com/search?l=Rust&p=1&q=ptr_to_from_bits&type=Code For potential pushback, some users in case they want to chime in - `@RSSchermer` https://github.com/RSSchermer/ARWA/blob/365bb68541447453fc44f6fbcc5d394bb94c14e9/arwa/src/html/custom_element.rs#L105 - `@strax` https://github.com/strax/pbr/blob/99616d1dbf42f93ec8dd668d05b3180649558180/openexr/src/core/alloc.rs#L36 - `@MiSawa` https://github.com/MiSawa/pomelo/blob/577c6223588d539295a71ff125d8f249e59f4146/crates/kernel/src/timer.rs#L50
2 parents 1dd515f + 6d943af commit 81ea610

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

library/core/src/ptr/const_ptr.rs

+10
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,11 @@ impl<T: ?Sized> *const T {
119119
/// assert_eq!(p1.to_bits() - p0.to_bits(), 4);
120120
/// ```
121121
#[unstable(feature = "ptr_to_from_bits", issue = "91126")]
122+
#[deprecated(
123+
since = "1.67",
124+
note = "replaced by the `exposed_addr` method, or update your code \
125+
to follow the strict provenance rules using its APIs"
126+
)]
122127
pub fn to_bits(self) -> usize
123128
where
124129
T: Sized,
@@ -140,6 +145,11 @@ impl<T: ?Sized> *const T {
140145
/// assert_eq!(<*const u8>::from_bits(1), dangling);
141146
/// ```
142147
#[unstable(feature = "ptr_to_from_bits", issue = "91126")]
148+
#[deprecated(
149+
since = "1.67",
150+
note = "replaced by the `ptr::from_exposed_addr` function, or update \
151+
your code to follow the strict provenance rules using its APIs"
152+
)]
143153
#[allow(fuzzy_provenance_casts)] // this is an unstable and semi-deprecated cast function
144154
pub fn from_bits(bits: usize) -> Self
145155
where

library/core/src/ptr/mut_ptr.rs

+10
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,11 @@ impl<T: ?Sized> *mut T {
125125
/// assert_eq!(p1.to_bits() - p0.to_bits(), 4);
126126
/// ```
127127
#[unstable(feature = "ptr_to_from_bits", issue = "91126")]
128+
#[deprecated(
129+
since = "1.67",
130+
note = "replaced by the `exposed_addr` method, or update your code \
131+
to follow the strict provenance rules using its APIs"
132+
)]
128133
pub fn to_bits(self) -> usize
129134
where
130135
T: Sized,
@@ -146,6 +151,11 @@ impl<T: ?Sized> *mut T {
146151
/// assert_eq!(<*mut u8>::from_bits(1), dangling);
147152
/// ```
148153
#[unstable(feature = "ptr_to_from_bits", issue = "91126")]
154+
#[deprecated(
155+
since = "1.67",
156+
note = "replaced by the `ptr::from_exposed_addr_mut` function, or \
157+
update your code to follow the strict provenance rules using its APIs"
158+
)]
149159
#[allow(fuzzy_provenance_casts)] // this is an unstable and semi-deprecated cast function
150160
pub fn from_bits(bits: usize) -> Self
151161
where

0 commit comments

Comments
 (0)