Skip to content

Commit b3b4824

Browse files
Dylan-DPCDylan-DPC
authored
Rollup merge of rust-lang#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 5c0e848 + 7d603dc commit b3b4824

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
@@ -62,7 +62,7 @@ impl BorrowedFd<'_> {
6262
/// the returned `BorrowedFd`, and it must not have the value `-1`.
6363
#[inline]
6464
#[unstable(feature = "io_safety", issue = "87074")]
65-
pub unsafe fn borrow_raw_fd(fd: RawFd) -> Self {
65+
pub unsafe fn borrow_raw(fd: RawFd) -> Self {
6666
assert_ne!(fd, u32::MAX as RawFd);
6767
// 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)
6868
unsafe { Self { fd, _phantom: PhantomData } }
@@ -231,7 +231,7 @@ impl AsFd for OwnedFd {
231231
// Safety: `OwnedFd` and `BorrowedFd` have the same validity
232232
// invariants, and the `BorrowdFd` is bounded by the lifetime
233233
// of `&self`.
234-
unsafe { BorrowedFd::borrow_raw_fd(self.as_raw_fd()) }
234+
unsafe { BorrowedFd::borrow_raw(self.as_raw_fd()) }
235235
}
236236
}
237237

‎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
@@ -131,7 +131,7 @@ impl BorrowedHandle<'_> {
131131
/// [here]: https://devblogs.microsoft.com/oldnewthing/20040302-00/?p=40443
132132
#[inline]
133133
#[unstable(feature = "io_safety", issue = "87074")]
134-
pub unsafe fn borrow_raw_handle(handle: RawHandle) -> Self {
134+
pub unsafe fn borrow_raw(handle: RawHandle) -> Self {
135135
Self { handle, _phantom: PhantomData }
136136
}
137137
}
@@ -345,7 +345,7 @@ impl AsHandle for OwnedHandle {
345345
// Safety: `OwnedHandle` and `BorrowedHandle` have the same validity
346346
// invariants, and the `BorrowdHandle` is bounded by the lifetime
347347
// of `&self`.
348-
unsafe { BorrowedHandle::borrow_raw_handle(self.as_raw_handle()) }
348+
unsafe { BorrowedHandle::borrow_raw(self.as_raw_handle()) }
349349
}
350350
}
351351

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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