modify std::os docs to be more consistent

> add intra doc links
> add a usage example for the os::windows module
This commit is contained in:
Sachin Cherian 2021-09-17 23:23:21 +05:30
parent c3c0f80d60
commit ec34aa61d6
16 changed files with 60 additions and 15 deletions

View File

@ -1,4 +1,6 @@
//! Linux-specific extensions to primitives in the `std::fs` module.
//! Linux-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs
#![stable(feature = "metadata_ext", since = "1.1.0")]

View File

@ -1,4 +1,6 @@
//! Linux-specific extensions to primitives in the `std::process` module.
//! Linux-specific extensions to primitives in the [`std::process`] module.
//!
//! [`std::process`]: crate::process
#![unstable(feature = "linux_pidfd", issue = "82971")]

View File

@ -1,4 +1,4 @@
//! Unix-specific extension to the primitives in the `std::ffi` module.
//! Unix-specific extensions to primitives in the [`std::ffi`] module.
//!
//! # Examples
//!
@ -31,6 +31,8 @@
//! let bytes = os_str.as_bytes();
//! assert_eq!(bytes, b"foo");
//! ```
//!
//! [`std::ffi`]: crate::ffi
#![stable(feature = "rust1", since = "1.0.0")]

View File

@ -1,4 +1,6 @@
//! Unix-specific extensions to primitives in the `std::fs` module.
//! Unix-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs
#![stable(feature = "rust1", since = "1.0.0")]

View File

@ -4,8 +4,8 @@
//! exposes Unix-specific functions that would otherwise be inappropriate as
//! part of the core `std` library.
//!
//! It exposes more ways to deal with platform-specific strings (`OsStr`,
//! `OsString`), allows to set permissions more granularly, extract low-level
//! It exposes more ways to deal with platform-specific strings ([`OsStr`],
//! [`OsString`]), allows to set permissions more granularly, extract low-level
//! file descriptors from files and sockets, and has platform-specific helpers
//! for spawning processes.
//!
@ -24,6 +24,9 @@
//! Ok(())
//! }
//! ```
//!
//! [`OsStr`]: crate::ffi::OsStr
//! [`OsString`]: crate::ffi::OsString
#![stable(feature = "rust1", since = "1.0.0")]
#![doc(cfg(unix))]

View File

@ -1,4 +1,4 @@
//! Unix-specific networking functionality
//! Unix-specific networking functionality.
#![stable(feature = "unix_socket", since = "1.10.0")]

View File

@ -1,4 +1,6 @@
//! Unix-specific extensions to primitives in the `std::process` module.
//! Unix-specific extensions to primitives in the [`std::process`] module.
//!
//! [`std::process`]: crate::process
#![stable(feature = "rust1", since = "1.0.0")]

View File

@ -1,4 +1,6 @@
//! Unix-specific extensions to primitives in the `std::thread` module.
//! Unix-specific extensions to primitives in the [`std::thread`] module.
//!
//! [`std::thread`]: crate::thread
#![stable(feature = "thread_extensions", since = "1.9.0")]

View File

@ -1,4 +1,6 @@
//! WASI-specific extension to the primitives in the `std::ffi` module
//! WASI-specific extensions to primitives in the [`std::ffi`] module
//!
//! [`std::ffi`]: crate::ffi
#![stable(feature = "rust1", since = "1.0.0")]

View File

@ -1,4 +1,6 @@
//! WASI-specific extensions to primitives in the `std::fs` module.
//! WASI-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs
#![deny(unsafe_op_in_unsafe_fn)]
#![unstable(feature = "wasi_ext", issue = "71213")]

View File

@ -24,6 +24,9 @@
//! Ok(())
//! }
//! ```
//!
//! [`OsStr`]: crate::ffi::OsStr
//! [`OsString`]: crate::ffi::OsString
#![stable(feature = "rust1", since = "1.0.0")]
#![deny(unsafe_op_in_unsafe_fn)]

View File

@ -1,4 +1,4 @@
//! Windows-specific extensions to the primitives in the `std::ffi` module.
//! Windows-specific extensions to primitives in the [`std::ffi`] module.
//!
//! # Overview
//!
@ -49,6 +49,7 @@
//! [ill-formed-utf-16]: https://simonsapin.github.io/wtf-8/#ill-formed-utf-16
//! [`collect`]: crate::iter::Iterator::collect
//! [U+FFFD]: crate::char::REPLACEMENT_CHARACTER
//! [`std::ffi`]: crate::ffi
#![stable(feature = "rust1", since = "1.0.0")]

View File

@ -1,4 +1,6 @@
//! Windows-specific extensions for the primitives in the `std::fs` module.
//! Windows-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs
#![stable(feature = "rust1", since = "1.0.0")]

View File

@ -5,6 +5,22 @@
//! the core `std` library. These extensions allow developers to use
//! `std` types and idioms with Windows in a way that the normal
//! platform-agnostic idioms would not normally support.
//!
//! # Examples
//!
//! ```no_run
//! use std::fs::File;
//! use std::os::windows::prelude::*;
//!
//! fn main() -> std::io::Result<()> {
//! let f = File::create("foo.txt")?;
//! let handle = f.as_raw_handle();
//!
//! // use handle with native windows bindings
//!
//! Ok(())
//! }
//! ```
#![stable(feature = "rust1", since = "1.0.0")]
#![doc(cfg(windows))]

View File

@ -1,4 +1,6 @@
//! Extensions to `std::process` for Windows.
//! Windows-specific extensions to primitives in the [`std::process`] module.
//!
//! [`std::process`]: crate::process
#![stable(feature = "process_extensions", since = "1.2.0")]

View File

@ -1,4 +1,6 @@
//! Extensions to `std::thread` for Windows.
//! Windows-specific extensions to primitives in the [`std::thread`] module.
//!
//! [`std::thread`]: crate::thread
#![stable(feature = "thread_extensions", since = "1.9.0")]