Non null convenience ops #117697

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

Jump to bottom

Merged

bors merged 6 commits into rust-lang:master from WaffleLapkin:non-null-convenience-ops

Nov 26, 2023

Member

WaffleLapkin commented Nov 8, 2023

Based on rust-lang/libs-team#251.

I went through all of the methods on *mut and added every method, which does not require additional safety conditions, to NonNull. (exceptions: guaranteed_eq, guaranteed_ne, with_metadata_of, it's unclear if they are useful here...)

I'm also not sure what types should the "second pointer parameter" be. *mut/*const might be more permissible, but given that NonNull doesn't coerce to them, it might also be annoying. For now I chose the "use NonNull everywhere" path, but I'm not sure it's the correct one...

_{I'm eepy, so I probably messed up somewhere while copying...}

cc @scottmcm
r? libs-api

WaffleLapkin added T-libs-api A-raw-pointers labels

rustbot assigned Amanieu

rustbot added the S-waiting-on-review label

Collaborator

bors commented Nov 18, 2023

☔ The latest upstream changes (presumably #117525) made this pull request unmergeable. Please resolve the merge conflicts.

Member

Amanieu commented Nov 23, 2023

Sorry this somehow fell off my queue.

r=me once conflicts are resolved.


          Add read/write/copy convenience methods to NonNull

36a587f

rust-cloud-vms bot force-pushed the non-null-convenience-ops branch from 8ca7c33 to 1dbc7c2 Compare

November 26, 2023 15:58

WaffleLapkin added 5 commits

November 26, 2023 16:01


          Add offset-ish convenience methods to NonNull

ebdc794


          Add offset_from-ish convenience methods to NonNull

4bcdd3b


          Add replace and swap convenience methods to NonNull

4cc46df


          Add align_offset convenience method to NonNull

2bcaa97


          Add is_aligned{,_to} convenience methods to NonNull

e1b4e8a

rust-cloud-vms bot force-pushed the non-null-convenience-ops branch from 1dbc7c2 to e1b4e8a Compare

November 26, 2023 16:01

Member Author

WaffleLapkin commented Nov 26, 2023

@bors r=Amanieu

Collaborator

bors commented Nov 26, 2023

📌 Commit e1b4e8a has been approved by Amanieu

It is now in the queue for this repository.

bors added S-waiting-on-bors and removed S-waiting-on-review labels

klensy reviewed

View reviewed changes

library/core/src/ptr/non_null.rs

Comment on lines +947 to +948

		// #[unstable(feature = "ptr_sub_ptr", issue = "95892")]
		// #[rustc_const_unstable(feature = "const_ptr_sub_ptr", issue = "95892")]

Contributor

klensy Nov 26, 2023

commented out code

klensy reviewed

View reviewed changes

library/core/src/ptr/non_null.rs

+                  /// [`ptr::write`]: crate::ptr::write()
+                  #[unstable(feature = "non_null_convenience", issue = "117691")]
+                  #[rustc_const_unstable(feature = "non_null_convenience", issue = "117691")]
+                  //#[rustc_const_unstable(feature = "const_ptr_write", issue = "86302")]

Contributor

klensy Nov 26, 2023

here too

klensy reviewed

View reviewed changes

library/core/src/ptr/non_null.rs

+                  #[doc(alias = "memset")]
+                  #[unstable(feature = "non_null_convenience", issue = "117691")]
+                  #[rustc_const_unstable(feature = "non_null_convenience", issue = "117691")]
+                  //#[rustc_const_unstable(feature = "const_ptr_write", issue = "86302")]

Contributor

klensy Nov 26, 2023

here

klensy reviewed

View reviewed changes

library/core/src/ptr/non_null.rs

+                  /// [`ptr::write_unaligned`]: crate::ptr::write_unaligned()
+                  #[unstable(feature = "non_null_convenience", issue = "117691")]
+                  #[rustc_const_unstable(feature = "non_null_convenience", issue = "117691")]
+                  //#[rustc_const_unstable(feature = "const_ptr_write", issue = "86302")]

Contributor

klensy Nov 26, 2023

here

klensy reviewed

View reviewed changes

library/core/src/ptr/non_null.rs

+                  /// [`ptr::swap`]: crate::ptr::swap()
+                  #[unstable(feature = "non_null_convenience", issue = "117691")]
+                  #[rustc_const_unstable(feature = "non_null_convenience", issue = "117691")]
+                  //#[rustc_const_unstable(feature = "const_swap", issue = "83163")]

Contributor

klensy Nov 26, 2023

too

klensy reviewed

View reviewed changes

library/core/src/ptr/non_null.rs

+                  /// ```
+                  #[unstable(feature = "non_null_convenience", issue = "117691")]
+                  #[rustc_const_unstable(feature = "non_null_convenience", issue = "117691")]
+                  //#[rustc_const_unstable(feature = "const_align_offset", issue = "90962")]

Contributor

klensy Nov 26, 2023

...

Member Author

WaffleLapkin commented Nov 26, 2023

bors added S-waiting-on-author and removed S-waiting-on-bors labels

Member Author

WaffleLapkin commented Nov 26, 2023

wait, no, it's actually fine.

@klensy all of those are "this is unstable under two features at the same time", kind of thing. If non_null_convenience gets stabilized before the commented-out ones, we need to not forget to consider moving those methods to the other unstable features.

@bors r=Amanieu

Collaborator

bors commented Nov 26, 2023

📌 Commit e1b4e8a has been approved by Amanieu

It is now in the queue for this repository.

bors removed the S-waiting-on-author label

bors added the S-waiting-on-bors label

Collaborator

bors commented Nov 26, 2023

⌛ Testing commit e1b4e8a with merge 1bcbb7c...

Collaborator

bors commented Nov 26, 2023

☀️ Test successful - checks-actions
Approved by: Amanieu
Pushing 1bcbb7c to master...

bors added the merged-by-bors label

bors merged commit 1bcbb7c into rust-lang:master

rustbot added this to the 1.76.0 milestone

Collaborator

rust-timer commented Nov 27, 2023

Finished benchmarking commit (1bcbb7c): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	3.6%	[2.3%, 4.8%]	2
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-4.6%	[-5.0%, -4.1%]	2
All ❌✅ (primary)	-	-	0

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-0.1%	[-0.1%, -0.0%]	50
Improvements ✅ (secondary)	-0.1%	[-0.1%, -0.1%]	4
All ❌✅ (primary)	-0.1%	[-0.1%, -0.0%]	50

Bootstrap: 676.117s -> 676.261s (0.02%)
Artifact size: 313.33 MiB -> 313.37 MiB (0.01%)

WaffleLapkin deleted the non-null-convenience-ops branch

November 27, 2023 18:00

WaffleLapkin mentioned this pull request

Tracking Issue for convenience methods on NonNull #117691

Closed

4 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-raw-pointers merged-by-bors S-waiting-on-bors T-libs-api