8000 Expand `ptr::fn_addr_eq()` documentation. by kpreid · Pull Request #131457 · rust-lang/rust · GitHub
[go: up one dir, main page]
Skip to content

Expand ptr::fn_addr_eq() documentation. #131457

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Expand ptr::fn_addr_eq() documentation. #131457

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57eacbb
Expand `ptr::fn_addr_eq()` documentation.
kpreid Oct 9, 2024
8e2ac49
Apply suggestions from code review
kpreid Oct 9, 2024
5280f15
Add "not guaranteed to be equal"
kpreid Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Urgau <3616612+Urgau@users.noreply.github.com>
  • Loading branch information
@kpreid @Urgau
kpreid and Urgau authored Oct 9, 2024
commit 8e2ac498f4e8240c21f1e4ed9ed8c2370a5913f7
6 changes: 4 additions & 2 deletions library/core/src/ptr/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2166,10 +2166,12 @@ pub fn addr_eq<T: ?Sized, U: ?Sized>(p: *const T, q: *const U) -> bool {
///
/// This is the same as `f == g`, but using this function makes clear that the potentially
/// surprising semantics of function pointer comparison are involved.
/// There are very few guarantees about how functions are compiled and they have no intrinsic
///
/// There are **very few guarantees** about how functions are compiled and they have no intrinsic
/// “identity”; in particular, this comparison:
///
/// * May return `true` unexpectedly, in cases where functions are equivalent.
///
/// For example, the following program is likely (but not guaranteed) to print `(true, true)`
/// when compiled with optimization:
///
Expand All @@ -2182,6 +2184,7 @@ pub fn addr_eq<T: ?Sized, U: ?Sized>(p: *const T, q: *const U) -> bool {
/// ```
///
/// * May return `false` in any case.
///
/// This is particularly likely with generic functions but may happen with any function.
/// (From an implementation perspective, this is possible because functions may sometimes be
/// processed more than once by the compiler, resulting in duplicate machine code.)
Expand All @@ -2207,7 +2210,6 @@ pub fn addr_eq<T: ?Sized, U: ?Sized>(p: *const T, q: *const U) -> bool {
/// ```
///
/// [subtype]: https://doc.rust-lang.org/reference/subtyping.html

#[unstable(feature = "ptr_fn_addr_eq", issue = "129322")]
#[inline(always)]
#[must_use = "function pointer comparison produces a value"]
Expand Down
Loading
0