Skip to content

Commit 2701c17

Browse files
kennytmkennytm
authored
Rollup merge of rust-lang#49829 - ecstatic-morse:os-docs, r=steveklabnik
Add doc links to `std::os` extension traits Addresses a small subset of rust-lang#29367. This adds documentation links to the original type for various OS-specific extension traits, and uses a common sentence for introducing such traits (which now consistently ends in a period).
2 parents b9dbf8e + d5bee64 commit 2701c17

File tree

24 files changed

+135
-60
lines changed

24 files changed

+135
-60
lines changed

‎src/libstd/os/android/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::android::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/bitrig/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::bitrig::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/dragonfly/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::dragonfly::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/emscripten/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::emscripten::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/freebsd/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::freebsd::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/fuchsia/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
use fs::Metadata;
1414
use sys_common::AsInner;
1515

16-
/// OS-specific extension methods for `fs::Metadata`
16+
/// OS-specific extensions to [`fs::Metadata`].
17+
///
18+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
1719
#[stable(feature = "metadata_ext", since = "1.1.0")]
1820
pub trait MetadataExt {
1921
#[stable(feature = "metadata_ext2", since = "1.8.0")]

‎src/libstd/os/haiku/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::haiku::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/ios/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::ios::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/linux/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::linux::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/macos/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::macos::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/netbsd/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::netbsd::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/openbsd/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::openbsd::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/os/solaris/fs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use sys_common::AsInner;
1818
#[allow(deprecated)]
1919
use os::solaris::raw;
2020

21-
/// OS-specific extension methods for `fs::Metadata`
21+
/// OS-specific extensions to [`fs::Metadata`].
22+
///
23+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
2224
#[stable(feature = "metadata_ext", since = "1.1.0")]
2325
pub trait MetadataExt {
2426
/// Gain a reference to the underlying `stat` structure which contains

‎src/libstd/sys/redox/ext/ffi.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Unix-specific extension to the primitives in the `std::ffi` module
11+
//! Redox-specific extension to the primitives in the `std::ffi` module.
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414

@@ -17,7 +17,9 @@ use mem;
1717
use sys::os_str::Buf;
1818
use sys_common::{FromInner, IntoInner, AsInner};
1919

20-
/// Unix-specific extensions to `OsString`.
20+
/// Redox-specific extensions to [`OsString`].
21+
///
22+
/// [`OsString`]: ../../../../std/ffi/struct.OsString.html
2123
#[stable(feature = "rust1", since = "1.0.0")]
2224
pub trait OsStringExt {
2325
/// Creates an `OsString` from a byte vector.
@@ -39,7 +41,9 @@ impl OsStringExt for OsString {
3941
}
4042
}
4143

42-
/// Unix-specific extensions to `OsStr`.
44+
/// Redox-specific extensions to [`OsStr`].
45+
///
46+
/// [`OsStr`]: ../../../../std/ffi/struct.OsStr.html
4347
#[stable(feature = "rust1", since = "1.0.0")]
4448
pub trait OsStrExt {
4549
#[stable(feature = "rust1", since = "1.0.0")]

‎src/libstd/sys/redox/ext/fs.rs

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use path::Path;
1818
use sys;
1919
use sys_common::{FromInner, AsInner, AsInnerMut};
2020

21-
/// Redox-specific extensions to `Permissions`
21+
/// Redox-specific extensions to [`fs::Permissions`].
22+
///
23+
/// [`fs::Permissions`]: ../../../../std/fs/struct.Permissions.html
2224
#[stable(feature = "fs_ext", since = "1.1.0")]
2325
pub trait PermissionsExt {
2426
/// Returns the underlying raw `mode_t` bits that are the standard Redox
@@ -95,7 +97,9 @@ impl PermissionsExt for Permissions {
9597
}
9698
}
9799

98-
/// Redox-specific extensions to `OpenOptions`
100+
/// Redox-specific extensions to [`fs::OpenOptions`].
101+
///
102+
/// [`fs::OpenOptions`]: ../../../../std/fs/struct.OpenOptions.html
99103
#[stable(feature = "fs_ext", since = "1.1.0")]
100104
pub trait OpenOptionsExt {
101105
/// Sets the mode bits that a new file will be created with.
@@ -163,13 +167,9 @@ impl OpenOptionsExt for OpenOptions {
163167
}
164168
}
165169

166-
// Hm, why are there casts here to the returned type, shouldn't the types always
167-
// be the same? Right you are! Turns out, however, on android at least the types
168-
// in the raw `stat` structure are not the same as the types being returned. Who
169-
// knew!
170-
//
171-
// As a result to make sure this compiles for all platforms we do the manual
172-
// casts and rely on manual lowering to `stat` if the raw type is desired.
170+
/// Redox-specific extensions to [`fs::Metadata`].
171+
///
172+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
173173
#[stable(feature = "metadata_ext", since = "1.1.0")]
174174
pub trait MetadataExt {
175175
#[stable(feature = "metadata_ext", since = "1.1.0")]
@@ -204,6 +204,13 @@ pub trait MetadataExt {
204204
fn blocks(&self) -> u64;
205205
}
206206

207+
// Hm, why are there casts here to the returned type, shouldn't the types always
208+
// be the same? Right you are! Turns out, however, on android at least the types
209+
// in the raw `stat` structure are not the same as the types being returned. Who
210+
// knew!
211+
//
212+
// As a result to make sure this compiles for all platforms we do the manual
213+
// casts and rely on manual lowering to `stat` if the raw type is desired.
207214
#[stable(feature = "metadata_ext", since = "1.1.0")]
208215
impl MetadataExt for fs::Metadata {
209216
fn dev(&self) -> u64 {
@@ -253,7 +260,12 @@ impl MetadataExt for fs::Metadata {
253260
}
254261
}
255262

256-
/// Add special Redox types (block/char device, fifo and socket)
263+
/// Redox-specific extensions for [`FileType`].
264+
///
265+
/// Adds support for special Unix file types such as block/character devices,
266+
/// pipes, and sockets.
267+
///
268+
/// [`FileType`]: ../../../../std/fs/struct.FileType.html
257269
#[stable(feature = "file_type_ext", since = "1.5.0")]
258270
pub trait FileTypeExt {
259271
/// Returns whether this file type is a block device.
@@ -307,8 +319,10 @@ pub fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()>
307319
sys::fs::symlink(src.as_ref(), dst.as_ref())
308320
}
309321

322+
/// Redox-specific extensions to [`fs::DirBuilder`].
323+
///
324+
/// [`fs::DirBuilder`]: ../../../../std/fs/struct.DirBuilder.html
310325
#[stable(feature = "dir_builder", since = "1.6.0")]
311-
/// An extension trait for `fs::DirBuilder` for Redox-specific options.
312326
pub trait DirBuilderExt {
313327
/// Sets the mode to create new directories with. This option defaults to
314328
/// 0o777.

‎src/libstd/sys/redox/ext/process.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Unix-specific extensions to primitives in the `std::process` module.
11+
//! Redox-specific extensions to primitives in the `std::process` module.
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414

@@ -18,7 +18,9 @@ use process;
1818
use sys;
1919
use sys_common::{AsInnerMut, AsInner, FromInner, IntoInner};
2020

21-
/// Unix-specific extensions to the `std::process::Command` builder
21+
/// Redox-specific extensions to the [`process::Command`] builder,
22+
///
23+
/// [`process::Command`]: ../../../../std/process/struct.Command.html
2224
#[stable(feature = "rust1", since = "1.0.0")]
2325
pub trait CommandExt {
2426
/// Sets the child process's user id. This translates to a
@@ -107,7 +109,9 @@ impl CommandExt for process::Command {
107109
}
108110
}
109111

110-
/// Unix-specific extensions to `std::process::ExitStatus`
112+
/// Redox-specific extensions to [`process::ExitStatus`].
113+
///
114+
/// [`process::ExitStatus`]: ../../../../std/process/struct.ExitStatus.html
111115
#[stable(feature = "rust1", since = "1.0.0")]
112116
pub trait ExitStatusExt {
113117
/// Creates a new `ExitStatus` from the raw underlying `i32` return value of

‎src/libstd/sys/redox/ext/thread.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Unix-specific extensions to primitives in the `std::thread` module.
11+
//! Redox-specific extensions to primitives in the `std::thread` module.
1212
1313
#![stable(feature = "thread_extensions", since = "1.9.0")]
1414

@@ -19,7 +19,9 @@ use thread::JoinHandle;
1919
#[allow(deprecated)]
2020
pub type RawPthread = usize;
2121

22-
/// Unix-specific extensions to `std::thread::JoinHandle`
22+
/// Redox-specific extensions to [`thread::JoinHandle`].
23+
///
24+
/// [`thread::JoinHandle`]: ../../../../std/thread/struct.JoinHandle.html
2325
#[stable(feature = "thread_extensions", since = "1.9.0")]
2426
pub trait JoinHandleExt {
2527
/// Extracts the raw pthread_t without taking ownership

‎src/libstd/sys/unix/ext/ffi.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ use mem;
1717
use sys::os_str::Buf;
1818
use sys_common::{FromInner, IntoInner, AsInner};
1919

20-
/// Unix-specific extensions to `OsString`.
20+
/// Unix-specific extensions to [`OsString`].
21+
///
22+
/// [`OsString`]: ../../../../std/ffi/struct.OsString.html
2123
#[stable(feature = "rust1", since = "1.0.0")]
2224
pub trait OsStringExt {
2325
/// Creates an [`OsString`] from a byte vector.
@@ -66,7 +68,9 @@ impl OsStringExt for OsString {
6668
}
6769
}
6870

69-
/// Unix-specific extensions to `OsStr`.
71+
/// Unix-specific extensions to [`OsStr`].
72+
///
73+
/// [`OsStr`]: ../../../../std/ffi/struct.OsStr.html
7074
#[stable(feature = "rust1", since = "1.0.0")]
7175
pub trait OsStrExt {
7276
#[stable(feature = "rust1", since = "1.0.0")]

‎src/libstd/sys/unix/ext/fs.rs

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,9 @@ impl FileExt for fs::File {
105105
}
106106
}
107107

108-
/// Unix-specific extensions to `Permissions`
108+
/// Unix-specific extensions to [`fs::Permissions`].
109+
///
110+
/// [`fs::Permissions`]: ../../../../std/fs/struct.Permissions.html
109111
#[stable(feature = "fs_ext", since = "1.1.0")]
110112
pub trait PermissionsExt {
111113
/// Returns the underlying raw `st_mode` bits that contain the standard
@@ -180,7 +182,9 @@ impl PermissionsExt for Permissions {
180182
}
181183
}
182184

183-
/// Unix-specific extensions to `OpenOptions`
185+
/// Unix-specific extensions to [`fs::OpenOptions`].
186+
///
187+
/// [`fs::OpenOptions`]: ../../../../std/fs/struct.OpenOptions.html
184188
#[stable(feature = "fs_ext", since = "1.1.0")]
185189
pub trait OpenOptionsExt {
186190
/// Sets the mode bits that a new file will be created with.
@@ -246,13 +250,9 @@ impl OpenOptionsExt for OpenOptions {
246250
}
247251
}
248252

249-
// Hm, why are there casts here to the returned type, shouldn't the types always
250-
// be the same? Right you are! Turns out, however, on android at least the types
251-
// in the raw `stat` structure are not the same as the types being returned. Who
252-
// knew!
253-
//
254-
// As a result to make sure this compiles for all platforms we do the manual
255-
// casts and rely on manual lowering to `stat` if the raw type is desired.
253+
/// Unix-specific extensions to [`fs::Metadata`].
254+
///
255+
/// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
256256
#[stable(feature = "metadata_ext", since = "1.1.0")]
257257
pub trait MetadataExt {
258258
/// Returns the ID of the device containing the file.
@@ -555,7 +555,12 @@ impl MetadataExt for fs::Metadata {
555555
fn blocks(&self) -> u64 { self.st_blocks() }
556556
}
557557

558-
/// Add support for special unix types (block/char device, fifo and socket).
558+
/// Unix-specific extensions for [`FileType`].
559+
///
560+
/// Adds support for special Unix file types such as block/character devices,
561+
/// pipes, and sockets.
562+
///
563+
/// [`FileType`]: ../../../../std/fs/struct.FileType.html
559564
#[stable(feature = "file_type_ext", since = "1.5.0")]
560565
pub trait FileTypeExt {
561566
/// Returns whether this file type is a block device.
@@ -701,10 +706,10 @@ pub fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()>
701706
sys::fs::symlink(src.as_ref(), dst.as_ref())
702707
}
703708

704-
#[stable(feature = "dir_builder", since = "1.6.0")]
705-
/// An extension trait for [`fs::DirBuilder`] for unix-specific options.
709+
/// Unix-specific extensions to [`fs::DirBuilder`].
706710
///
707711
/// [`fs::DirBuilder`]: ../../../../std/fs/struct.DirBuilder.html
712+
#[stable(feature = "dir_builder", since = "1.6.0")]
708713
pub trait DirBuilderExt {
709714
/// Sets the mode to create new directories with. This option defaults to
710715
/// 0o777.

0 commit comments

Comments
 (0)