std/os/windows/
mod.rs

1//! Platform-specific extensions to `std` for Windows.
2//!
3//! Provides access to platform-level information for Windows, and exposes
4//! Windows-specific idioms that would otherwise be inappropriate as part
5//! the core `std` library. These extensions allow developers to use
6//! `std` types and idioms with Windows in a way that the normal
7//! platform-agnostic idioms would not normally support.
8//!
9//! # Examples
10//!
11#![cfg_attr(windows, doc = "```no_run")]
12#![cfg_attr(not(windows), doc = "```ignore (needs windows)")]
13//! use std::fs::File;
14//! use std::os::windows::prelude::*;
15//!
16//! fn main() -> std::io::Result<()> {
17//!     let f = File::create("foo.txt")?;
18//!     let handle = f.as_raw_handle();
19//!
20//!     // use handle with native windows bindings
21//!
22//!     Ok(())
23//! }
24//! ```
25
26#![stable(feature = "rust1", since = "1.0.0")]
27#![doc(cfg(windows))]
28#![deny(unsafe_op_in_unsafe_fn)]
29
30pub mod ffi;
31pub mod fs;
32pub mod io;
33#[unstable(feature = "windows_unix_domain_sockets", issue = "150487")]
34pub mod net;
35pub mod process;
36pub mod raw;
37pub mod thread;
38
39#[unstable(feature = "codeview_annotation", issue = "163964")]
40#[cfg(windows)]
41pub use core::os::windows::{CodeViewAnnotationArgs, codeview_annotation};
42
43/// A prelude for conveniently writing platform-specific code.
44///
45/// Includes all extension traits, and some important type definitions.
46#[stable(feature = "rust1", since = "1.0.0")]
47pub mod prelude {
48    #[doc(no_inline)]
49    #[stable(feature = "rust1", since = "1.0.0")]
50    pub use super::ffi::{OsStrExt, OsStringExt};
51    #[doc(no_inline)]
52    #[stable(feature = "file_offset", since = "1.15.0")]
53    pub use super::fs::FileExt;
54    #[doc(no_inline)]
55    #[stable(feature = "rust1", since = "1.0.0")]
56    pub use super::fs::{MetadataExt, OpenOptionsExt};
57    #[doc(no_inline)]
58    #[stable(feature = "rust1", since = "1.0.0")]
59    pub use super::io::{
60        AsHandle, AsSocket, BorrowedHandle, BorrowedSocket, FromRawHandle, FromRawSocket,
61        HandleOrInvalid, IntoRawHandle, IntoRawSocket, OwnedHandle, OwnedSocket,
62    };
63    #[doc(no_inline)]
64    #[stable(feature = "rust1", since = "1.0.0")]
65    pub use super::io::{AsRawHandle, AsRawSocket, RawHandle, RawSocket};
66}
std/os/windows/mod.rs

std/os/windows/
mod.rs
