rust-lang / libs-team

The home of the library team
Apache License 2.0
115 stars 18 forks source link

Add `ptr::addr_eq` for use with pointers-to-DSTs #274

Closed scottmcm closed 11 months ago

scottmcm commented 11 months ago

Proposal

Problem statement

As discussed in https://github.com/rust-lang/rust/issues/106447 (and in the 2023-09-26 lang meeting that inspired this ACP), equality for pointers to DSTs is awkward.

Motivating examples or use cases

If we're going to work towards deprecating it, it would help to have methods with clear intent that people could use instead. That won't be a 100% solution (not even close), but at least there'd be a simple

Solution sketch

in core::ptr and std::ptr

/// Compares the *addresses* of the two pointers for equality,
/// ignoring any metadata in fat pointers.
///
/// If the arguments are thin pointers of the same type,
/// then this is the same as [`ptr::eq`].
///
/// # Examples
///
/// ```
/// let a = [1, 2, 3];
/// let slice = &a[..];
/// let first = &a[0];
/// assert!(std::ptr::addr_eq(slice, first));
/// assert!(!std::ptr::eq::<dyn Debug>(slice, first));
/// ```
pub fn addr_eq<T: ?Sized, U: ?Sized>(p: *const T, q: *const U) -> bool {
    (p as *const ()) == (q as *const ())
}

Alternatives

Links and related work

What happens now?

This issue is part of the libs-api team API change proposal process. Once this issue is filed the libs-api team will review open proposals as capability becomes available. Current response times do not have a clear estimate, but may be up to several months.

Possible responses

The libs team may respond in various different ways. First, the team will consider the problem (this doesn't require any concrete solution or alternatives to have been proposed):

Second, if there's a concrete solution:

dtolnay commented 11 months ago

Seconded! Feel free to send a PR implementing this. Thank you!