Skip to content

Commit c9dc44b

Browse files
Dylan-DPCDylan-DPC
authored
Rollup merge of #93663 - sunfishcode:sunfishcode/as-raw-name, r=joshtriplett
Rename `BorrowedFd::borrow_raw_fd` to `BorrowedFd::borrow_raw`. Also, rename `BorrowedHandle::borrow_raw_handle` and `BorrowedSocket::borrow_raw_socket` to `BorrowedHandle::borrow_raw` and `BorrowedSocket::borrow_raw`. This is just a minor rename to reduce redundancy in the user code calling these functions, and to eliminate an inessential difference between `BorrowedFd` code and `BorrowedHandle`/`BorrowedSocket` code. While here, add a simple test exercising `BorrowedFd::borrow_raw_fd`. r? ``````@joshtriplett``````
2 parents bc1a890 + 7d603dc commit c9dc44b

File tree

6 files changed

+62
-25
lines changed

6 files changed

+62
-25
lines changed

‎library/std/src/os/fd/mod.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ pub mod owned;
1111

1212
// Implementations for `AsRawFd` etc. for network types.
1313
mod net;
14+
15+
#[cfg(test)]
16+
mod tests;

‎library/std/src/os/fd/owned.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ impl BorrowedFd<'_> {
6666
/// the returned `BorrowedFd`, and it must not have the value `-1`.
6767
#[inline]
6868
#[unstable(feature = "io_safety", issue = "87074")]
69-
pub unsafe fn borrow_raw_fd(fd: RawFd) -> Self {
69+
pub unsafe fn borrow_raw(fd: RawFd) -> Self {
7070
assert_ne!(fd, u32::MAX as RawFd);
7171
// SAFETY: we just asserted that the value is in the valid range and isn't `-1` (the only value bigger than `0xFF_FF_FF_FE` unsigned)
7272
unsafe { Self { fd, _phantom: PhantomData } }
@@ -235,7 +235,7 @@ impl AsFd for OwnedFd {
235235
// Safety: `OwnedFd` and `BorrowedFd` have the same validity
236236
// invariants, and the `BorrowdFd` is bounded by the lifetime
237237
// of `&self`.
238-
unsafe { BorrowedFd::borrow_raw_fd(self.as_raw_fd()) }
238+
unsafe { BorrowedFd::borrow_raw(self.as_raw_fd()) }
239239
}
240240
}
241241

‎library/std/src/os/fd/tests.rs

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#[cfg(any(unix, target_os = "wasi"))]
2+
#[test]
3+
fn test_raw_fd() {
4+
#[cfg(unix)]
5+
use crate::os::unix::io::{AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, RawFd};
6+
#[cfg(target_os = "wasi")]
7+
use crate::os::wasi::io::{AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, RawFd};
8+
9+
let raw_fd: RawFd = crate::io::stdin().as_raw_fd();
10+
11+
let stdin_as_file = unsafe { crate::fs::File::from_raw_fd(raw_fd) };
12+
assert_eq!(stdin_as_file.as_raw_fd(), raw_fd);
13+
assert_eq!(unsafe { BorrowedFd::borrow_raw(raw_fd).as_raw_fd() }, raw_fd);
14+
assert_eq!(stdin_as_file.into_raw_fd(), 0);
15+
}
16+
17+
#[cfg(any(unix, target_os = "wasi"))]
18+
#[test]
19+
fn test_fd() {
20+
#[cfg(unix)]
21+
use crate::os::unix::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
22+
#[cfg(target_os = "wasi")]
23+
use crate::os::wasi::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
24+
25+
let stdin = crate::io::stdin();
26+
let fd: BorrowedFd<'_> = stdin.as_fd();
27+
let raw_fd: RawFd = fd.as_raw_fd();
28+
let owned_fd: OwnedFd = unsafe { OwnedFd::from_raw_fd(raw_fd) };
29+
30+
let stdin_as_file = crate::fs::File::from(owned_fd);
31+
32+
assert_eq!(stdin_as_file.as_fd().as_raw_fd(), raw_fd);
33+
assert_eq!(Into::<OwnedFd>::into(stdin_as_file).into_raw_fd(), raw_fd);
34+
}

‎library/std/src/os/windows/io/handle.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ impl BorrowedHandle<'_> {
135135
/// [here]: https://devblogs.microsoft.com/oldnewthing/20040302-00/?p=40443
136136
#[inline]
137137
#[unstable(feature = "io_safety", issue = "87074")]
138-
pub unsafe fn borrow_raw_handle(handle: RawHandle) -> Self {
138+
pub unsafe fn borrow_raw(handle: RawHandle) -> Self {
139139
Self { handle, _phantom: PhantomData }
140140
}
141141
}
@@ -349,7 +349,7 @@ impl AsHandle for OwnedHandle {
349349
// Safety: `OwnedHandle` and `BorrowedHandle` have the same validity
350350
// invariants, and the `BorrowdHandle` is bounded by the lifetime
351351
// of `&self`.
352-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
352+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
353353
}
354354
}
355355

@@ -377,49 +377,49 @@ impl From<OwnedHandle> for fs::File {
377377
impl AsHandle for crate::io::Stdin {
378378
#[inline]
379379
fn as_handle(&self) -> BorrowedHandle<'_> {
380-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
380+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
381381
}
382382
}
383383

384384
impl<'a> AsHandle for crate::io::StdinLock<'a> {
385385
#[inline]
386386
fn as_handle(&self) -> BorrowedHandle<'_> {
387-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
387+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
388388
}
389389
}
390390

391391
impl AsHandle for crate::io::Stdout {
392392
#[inline]
393393
fn as_handle(&self) -> BorrowedHandle<'_> {
394-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
394+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
395395
}
396396
}
397397

398398
impl<'a> AsHandle for crate::io::StdoutLock<'a> {
399399
#[inline]
400400
fn as_handle(&self) -> BorrowedHandle<'_> {
401-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
401+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
402402
}
403403
}
404404

405405
impl AsHandle for crate::io::Stderr {
406406
#[inline]
407407
fn as_handle(&self) -> BorrowedHandle<'_> {
408-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
408+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
409409
}
410410
}
411411

412412
impl<'a> AsHandle for crate::io::StderrLock<'a> {
413413
#[inline]
414414
fn as_handle(&self) -> BorrowedHandle<'_> {
415-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
415+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
416416
}
417417
}
418418

419419
impl AsHandle for crate::process::ChildStdin {
420420
#[inline]
421421
fn as_handle(&self) -> BorrowedHandle<'_> {
422-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
422+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
423423
}
424424
}
425425

@@ -433,7 +433,7 @@ impl From<crate::process::ChildStdin> for OwnedHandle {
433433
impl AsHandle for crate::process::ChildStdout {
434434
#[inline]
435435
fn as_handle(&self) -> BorrowedHandle<'_> {
436-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
436+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
437437
}
438438
}
439439

@@ -447,7 +447,7 @@ impl From<crate::process::ChildStdout> for OwnedHandle {
447447
impl AsHandle for crate::process::ChildStderr {
448448
#[inline]
449449
fn as_handle(&self) -> BorrowedHandle<'_> {
450-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
450+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
451451
}
452452
}
453453

@@ -461,7 +461,7 @@ impl From<crate::process::ChildStderr> for OwnedHandle {
461461
impl<T> AsHandle for crate::thread::JoinHandle<T> {
462462
#[inline]
463463
fn as_handle(&self) -> BorrowedHandle<'_> {
464-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
464+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
465465
}
466466
}
467467

‎library/std/src/os/windows/io/socket.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ impl BorrowedSocket<'_> {
7171
/// `INVALID_SOCKET`.
7272
#[inline]
7373
#[unstable(feature = "io_safety", issue = "87074")]
74-
pub unsafe fn borrow_raw_socket(socket: RawSocket) -> Self {
74+
pub unsafe fn borrow_raw(socket: RawSocket) -> Self {
7575
debug_assert_ne!(socket, c::INVALID_SOCKET as RawSocket);
7676
Self { socket, _phantom: PhantomData }
7777
}
@@ -243,14 +243,14 @@ impl AsSocket for OwnedSocket {
243243
// Safety: `OwnedSocket` and `BorrowedSocket` have the same validity
244244
// invariants, and the `BorrowdSocket` is bounded by the lifetime
245245
// of `&self`.
246-
unsafe { BorrowedSocket::borrow_raw_socket(self.as_raw_socket()) }
246+
unsafe { BorrowedSocket::borrow_raw(self.as_raw_socket()) }
247247
}
248248
}
249249

250250
impl AsSocket for crate::net::TcpStream {
251251
#[inline]
252252
fn as_socket(&self) -> BorrowedSocket<'_> {
253-
unsafe { BorrowedSocket::borrow_raw_socket(self.as_raw_socket()) }
253+
unsafe { BorrowedSocket::borrow_raw(self.as_raw_socket()) }
254254
}
255255
}
256256

@@ -271,7 +271,7 @@ impl From<OwnedSocket> for crate::net::TcpStream {
271271
impl AsSocket for crate::net::TcpListener {
272272
#[inline]
273273
fn as_socket(&self) -> BorrowedSocket<'_> {
274-
unsafe { BorrowedSocket::borrow_raw_socket(self.as_raw_socket()) }
274+
unsafe { BorrowedSocket::borrow_raw(self.as_raw_socket()) }
275275
}
276276
}
277277

@@ -292,7 +292,7 @@ impl From<OwnedSocket> for crate::net::TcpListener {
292292
impl AsSocket for crate::net::UdpSocket {
293293
#[inline]
294294
fn as_socket(&self) -> BorrowedSocket<'_> {
295-
unsafe { BorrowedSocket::borrow_raw_socket(self.as_raw_socket()) }
295+
unsafe { BorrowedSocket::borrow_raw(self.as_raw_socket()) }
296296
}
297297
}
298298

‎library/std/src/sys/unix/stdio.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,46 +96,46 @@ pub fn panic_output() -> Option<impl io::Write> {
9696
impl AsFd for io::Stdin {
9797
#[inline]
9898
fn as_fd(&self) -> BorrowedFd<'_> {
99-
unsafe { BorrowedFd::borrow_raw_fd(libc::STDIN_FILENO) }
99+
unsafe { BorrowedFd::borrow_raw(libc::STDIN_FILENO) }
100100
}
101101
}
102102

103103
#[unstable(feature = "io_safety", issue = "87074")]
104104
impl<'a> AsFd for io::StdinLock<'a> {
105105
#[inline]
106106
fn as_fd(&self) -> BorrowedFd<'_> {
107-
unsafe { BorrowedFd::borrow_raw_fd(libc::STDIN_FILENO) }
107+
unsafe { BorrowedFd::borrow_raw(libc::STDIN_FILENO) }
108108
}
109109
}
110110

111111
#[unstable(feature = "io_safety", issue = "87074")]
112112
impl AsFd for io::Stdout {
113113
#[inline]
114114
fn as_fd(&self) -> BorrowedFd<'_> {
115-
unsafe { BorrowedFd::borrow_raw_fd(libc::STDOUT_FILENO) }
115+
unsafe { BorrowedFd::borrow_raw(libc::STDOUT_FILENO) }
116116
}
117117
}
118118

119119
#[unstable(feature = "io_safety", issue = "87074")]
120120
impl<'a> AsFd for io::StdoutLock<'a> {
121121
#[inline]
122122
fn as_fd(&self) -> BorrowedFd<'_> {
123-
unsafe { BorrowedFd::borrow_raw_fd(libc::STDOUT_FILENO) }
123+
unsafe { BorrowedFd::borrow_raw(libc::STDOUT_FILENO) }
124124
}
125125
}
126126

127127
#[unstable(feature = "io_safety", issue = "87074")]
128128
impl AsFd for io::Stderr {
129129
#[inline]
130130
fn as_fd(&self) -> BorrowedFd<'_> {
131-
unsafe { BorrowedFd::borrow_raw_fd(libc::STDERR_FILENO) }
131+
unsafe { BorrowedFd::borrow_raw(libc::STDERR_FILENO) }
132132
}
133133
}
134134

135135
#[unstable(feature = "io_safety", issue = "87074")]
136136
impl<'a> AsFd for io::StderrLock<'a> {
137137
#[inline]
138138
fn as_fd(&self) -> BorrowedFd<'_> {
139-
unsafe { BorrowedFd::borrow_raw_fd(libc::STDERR_FILENO) }
139+
unsafe { BorrowedFd::borrow_raw(libc::STDERR_FILENO) }
140140
}
141141
}

0 commit comments

Comments
 (0)