Move `OsStringExt` and `OsStrExt` to `std::os` #84967

CDirkx · 2021-05-05T21:47:30Z

Moves the OsStringExt and OsStrExt traits and implementations from sys_common to os. sys_common is for abstractions over sys and shouldn't really contain publicly exported items.

This does introduce some duplication: the traits and implementations are now duplicated in unix, wasi, hermit, and sgx. However, I would argue that this duplication is no different to how something like MetadataExt is duplicated in linux, vxworkx, redox, solaris etc. The duplication also matches the fact that the traits on different platforms are technically distinct types: any platform is free to add it's own extra methods to the extension trait.

rust-highfive · 2021-05-05T21:47:33Z

r? @m-ou-se

(rust-highfive has picked a reviewer for you, use r? to override)

library/std/src/os/fortanix_sgx/ffi.rs

@@ -34,5 +34,68 @@

 #![unstable(feature = "sgx_platform", issue = "56975")]

-#[unstable(feature = "sgx_platform", issue = "56975")]


CDirkx · 2021-05-13T15:39:33Z

library/std/src/sys_common/os_str_bytes.rs

-// FIXME:
-// `Buf::as_slice` current implementation relies
-// on `Slice` being layout-compatible with `[u8]`.
-// When attribute privacy is implemented, `Slice` should be annotated as `#[repr(transparent)]`.
-// Anyway, `Slice` representation and layout are considered implementation detail, are
-// not documented and must not be relied upon.
-pub(crate) struct Slice {
+#[repr(transparent)]
+pub struct Slice {


Because Buf and Slice now no longer live in a publicly exported module they can be marked as pub and repr(transparent) as normal.

bors · 2021-05-20T21:34:56Z

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

m-ou-se · 2021-06-05T14:14:42Z

I don't think we should be duplicating this. Duplication in std/src/sys has often led to badly maintained code in the past, where only some copies were updated. (E.g. documentation patches, etc.)

It might be good to have each platform opt-in to these extensions instead of just using not(windows) in sys_common/mod like it is now, but if we do that, we shouldn't be duplicating so much code and documentation.

…e is reused on other platforms.

CDirkx · 2021-06-20T10:52:25Z

I tried another approach of reusing code within std::os using #[path], like is done in sys. This removes the earlier duplication while moving OsStrExt/OsStringExt to the (in my opinion) more appropriate location with all the other extension traits.

One potential problem I could think of is that it is more easy to forget that a file is reused on other platforms, more so than in sys. A unix specific change to for example documentation would be incorrect on other platforms. Because of this I added a comment explicitly stating that the file is reused.

What are your thoughts on this approach? If you approve I could later look into if there are more files in std::os that can also be deduplicated this way.

m-ou-se · 2021-06-20T14:17:14Z

Thanks!

This looks very reasonable to me.

We could also have a os::common module or something for things used by multiple platforms, but in many ways, os::unix is that already.

@bors r+

bors · 2021-06-20T14:17:15Z

📌 Commit ad7b897 has been approved by m-ou-se

bors · 2021-06-20T16:42:18Z

⌛ Testing commit ad7b897 with merge dd94145...

bors · 2021-06-20T19:22:58Z

☀️ Test successful - checks-actions
Approved by: m-ou-se
Pushing dd94145 to master...

Move `os_str_bytes` to `sys::unix` Followup to rust-lang#84967, with `OsStrExt` and `OsStringExt` moved out of `sys_common`, there is no reason anymore for `os_str_bytes` to live in `sys_common` and not in sys. This pr moves it to the location `sys::unix::os_str` and reuses the code on other platforms via `#[path]` (as is common in `sys`) instead of importing.

rust-highfive assigned m-ou-se May 5, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 5, 2021

CDirkx commented May 5, 2021

View reviewed changes

library/std/src/os/fortanix_sgx/ffi.rs

@@ -34,5 +34,68 @@

#![unstable(feature = "sgx_platform", issue = "56975")]

#[unstable(feature = "sgx_platform", issue = "56975")]

This comment was marked as outdated.

Sign in to view

This comment has been minimized.

Sign in to view

rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label May 6, 2021

CDirkx force-pushed the os_str_ext branch from 51d4561 to 685503f Compare May 6, 2021 18:36

CDirkx commented May 13, 2021

View reviewed changes

CDirkx force-pushed the os_str_ext branch from 39d1cfe to bf784cb Compare May 23, 2021 01:41

m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 5, 2021

CDirkx added 2 commits June 20, 2021 11:55

Move OsStringExt and OsStrExt to std::os

1a96d22

Make os_str_bytes::{Buf, Slice} pub and repr(transparent)

835561a

CDirkx force-pushed the os_str_ext branch from bf784cb to 835561a Compare June 20, 2021 09:56

Add comment to std::os::unix::ffi::os_str explaining that the modul…

ad7b897

…e is reused on other platforms.

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 20, 2021

bors added the merged-by-bors This PR was explicitly merged by bors. label Jun 20, 2021

bors merged commit dd94145 into rust-lang:master Jun 20, 2021

rustbot added this to the 1.55.0 milestone Jun 20, 2021

This was referenced Jun 20, 2021

Merge sys_common::bytestring back into os_str_bytes #85001

Merged

Extract sys::args::Args implementation to sys_common #84503

Closed

CDirkx deleted the os_str_ext branch June 21, 2021 09:47

CDirkx mentioned this pull request Jun 21, 2021

Move os_str_bytes to sys::unix #86509

Merged

ChrisDenton mentioned this pull request Apr 30, 2022

#[repr(transparent)] in sys::windows::os_str::Slice #96577

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move `OsStringExt` and `OsStrExt` to `std::os` #84967

Move `OsStringExt` and `OsStrExt` to `std::os` #84967

CDirkx commented May 5, 2021 •

edited

Loading

rust-highfive commented May 5, 2021

This comment was marked as outdated.

This comment has been minimized.

CDirkx May 13, 2021 •

edited

Loading

bors commented May 20, 2021

m-ou-se commented Jun 5, 2021

CDirkx commented Jun 20, 2021

m-ou-se commented Jun 20, 2021

bors commented Jun 20, 2021

bors commented Jun 20, 2021

bors commented Jun 20, 2021

		@@ -34,5 +34,68 @@

		#![unstable(feature = "sgx_platform", issue = "56975")]

		#[unstable(feature = "sgx_platform", issue = "56975")]

Move OsStringExt and OsStrExt to std::os #84967

Move OsStringExt and OsStrExt to std::os #84967

Conversation

CDirkx commented May 5, 2021 • edited Loading

rust-highfive commented May 5, 2021

This comment was marked as outdated.

This comment has been minimized.

CDirkx May 13, 2021 • edited Loading

Choose a reason for hiding this comment

bors commented May 20, 2021

m-ou-se commented Jun 5, 2021

CDirkx commented Jun 20, 2021

m-ou-se commented Jun 20, 2021

bors commented Jun 20, 2021

bors commented Jun 20, 2021

bors commented Jun 20, 2021

Move `OsStringExt` and `OsStrExt` to `std::os` #84967

Move `OsStringExt` and `OsStrExt` to `std::os` #84967

CDirkx commented May 5, 2021 •

edited

Loading

CDirkx May 13, 2021 •

edited

Loading