Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
scottmcm opened this issue Sep 30, 2023 · 1 comment
Closed

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

scottmcm opened this issue Sep 30, 2023 · 1 comment
Labels
ACP-accepted API Change Proposal is accepted (seconded with no objections) api-change-proposal A proposal to add or alter unstable APIs in the standard libraries T-libs-api

Comments

@scottmcm
Copy link
Member

scottmcm commented Sep 30, 2023

Proposal

Problem statement

As discussed in rust-lang/rust#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

  • Different name? Method instead of function?
  • I wrote it heterogeneous since address comparison works fine like that, but homogeneous could also make sense.
  • Newtypes that change the PartialEq implementation?
  • Different pointer type entirely?
  • Additional functions for addr_and_meta_eq or something?

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):

  • We think this problem seems worth solving, and the standard library might be the right place to solve it.
  • We think that this probably doesn't belong in the standard library.

Second, if there's a concrete solution:

  • We think this specific solution looks roughly right, approved, you or someone else should implement this. (Further review will still happen on the subsequent implementation PR.)
  • We're not sure this is the right solution, and the alternatives or other materials don't give us enough information to be sure about that. Here are some questions we have that aren't answered, or rough ideas about alternatives we'd want to see discussed.
@scottmcm scottmcm added api-change-proposal A proposal to add or alter unstable APIs in the standard libraries T-libs-api labels Sep 30, 2023
@dtolnay
Copy link
Member

dtolnay commented Sep 30, 2023

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

@dtolnay dtolnay added the ACP-accepted API Change Proposal is accepted (seconded with no objections) label Sep 30, 2023
@dtolnay dtolnay closed this as completed Sep 30, 2023
bors added a commit to rust-lang-ci/rust that referenced this issue Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ACP-accepted API Change Proposal is accepted (seconded with no objections) api-change-proposal A proposal to add or alter unstable APIs in the standard libraries T-libs-api
Projects
None yet
Development

No branches or pull requests

2 participants