std: Stabilize parts of std::os::platform::io
This commit stabilizes the platform-specific `io` modules, specifically around
the traits having to do with the raw representation of each object on each
platform.
Specifically, the following material was stabilized:
* `AsRaw{Fd,Socket,Handle}`
* `RawFd` (renamed from `Fd`)
* `RawHandle` (renamed from `Handle`)
* `RawSocket` (renamed from `Socket`)
* `AsRaw{Fd,Socket,Handle}` implementations
* `std::os::{unix, windows}::io`
The following material was added as `#[unstable]`:
* `FromRaw{Fd,Socket,Handle}`
* Implementations for various primitives
There are a number of future improvements that are possible to make to this
module, but this should cover a good bit of functionality desired from these
modules for now. Some specific future additions may include:
* `IntoRawXXX` traits to consume the raw representation and cancel the
auto-destructor.
* `Fd`, `Socket`, and `Handle` abstractions that behave like Rust objects and
have nice methods for various syscalls.
At this time though, these are considered backwards-compatible extensions and
will not be stabilized at this time.
This commit is a breaking change due to the addition of `Raw` in from of the
type aliases in each of the platform-specific modules.
[breaking-change]
This commit is contained in:
@@ -16,112 +16,188 @@
|
||||
|
||||
#![stable(feature = "rust1", since = "1.0.0")]
|
||||
|
||||
#[unstable(feature = "io_ext",
|
||||
reason = "organization may change slightly and the primitives \
|
||||
provided may be tweaked")]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub mod io {
|
||||
use fs;
|
||||
use libc;
|
||||
use net;
|
||||
use sys_common::AsInner;
|
||||
use sys_common::{net2, AsInner, FromInner};
|
||||
use sys;
|
||||
|
||||
#[allow(deprecated)]
|
||||
use old_io;
|
||||
|
||||
/// Raw HANDLEs.
|
||||
pub type Handle = libc::HANDLE;
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub type RawHandle = libc::HANDLE;
|
||||
|
||||
/// Raw SOCKETs.
|
||||
pub type Socket = libc::SOCKET;
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub type RawSocket = libc::SOCKET;
|
||||
|
||||
/// Extract raw handles.
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub trait AsRawHandle {
|
||||
/// Extract the raw handle, without taking any ownership.
|
||||
fn as_raw_handle(&self) -> Handle;
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
fn as_raw_handle(&self) -> RawHandle;
|
||||
}
|
||||
|
||||
/// Construct I/O objects from raw handles.
|
||||
#[unstable(feature = "from_raw_os",
|
||||
reason = "recent addition to the std::os::windows::io module")]
|
||||
pub trait FromRawHandle {
|
||||
/// Construct a new I/O object from the specified raw handle.
|
||||
///
|
||||
/// This function will **consume ownership** of the handle given,
|
||||
/// passing responsibility for closing the handle to the returned
|
||||
/// object.
|
||||
fn from_raw_handle(handle: RawHandle) -> Self;
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawHandle for old_io::fs::File {
|
||||
fn as_raw_handle(&self) -> Handle {
|
||||
fn as_raw_handle(&self) -> RawHandle {
|
||||
self.as_inner().handle()
|
||||
}
|
||||
}
|
||||
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawHandle for fs::File {
|
||||
fn as_raw_handle(&self) -> Handle {
|
||||
fn as_raw_handle(&self) -> RawHandle {
|
||||
self.as_inner().handle().raw()
|
||||
}
|
||||
}
|
||||
|
||||
#[unstable(feature = "from_raw_os", reason = "trait is unstable")]
|
||||
impl FromRawHandle for fs::File {
|
||||
fn from_raw_handle(handle: RawHandle) -> fs::File {
|
||||
fs::File::from_inner(sys::fs2::File::from_inner(handle))
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawHandle for old_io::pipe::PipeStream {
|
||||
fn as_raw_handle(&self) -> Handle {
|
||||
fn as_raw_handle(&self) -> RawHandle {
|
||||
self.as_inner().handle()
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawHandle for old_io::net::pipe::UnixStream {
|
||||
fn as_raw_handle(&self) -> Handle {
|
||||
fn as_raw_handle(&self) -> RawHandle {
|
||||
self.as_inner().handle()
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawHandle for old_io::net::pipe::UnixListener {
|
||||
fn as_raw_handle(&self) -> Handle {
|
||||
fn as_raw_handle(&self) -> RawHandle {
|
||||
self.as_inner().handle()
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawHandle for old_io::net::pipe::UnixAcceptor {
|
||||
fn as_raw_handle(&self) -> Handle {
|
||||
fn as_raw_handle(&self) -> RawHandle {
|
||||
self.as_inner().handle()
|
||||
}
|
||||
}
|
||||
|
||||
/// Extract raw sockets.
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub trait AsRawSocket {
|
||||
fn as_raw_socket(&self) -> Socket;
|
||||
/// Extract the underlying raw socket from this object.
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
fn as_raw_socket(&self) -> RawSocket;
|
||||
}
|
||||
|
||||
/// Create I/O objects from raw sockets.
|
||||
#[unstable(feature = "from_raw_os", reason = "recent addition to module")]
|
||||
pub trait FromRawSocket {
|
||||
/// Creates a new I/O object from the given raw socket.
|
||||
///
|
||||
/// This function will **consume ownership** of the socket provided and
|
||||
/// it will be closed when the returned object goes out of scope.
|
||||
fn from_raw_socket(sock: RawSocket) -> Self;
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for old_io::net::tcp::TcpStream {
|
||||
fn as_raw_socket(&self) -> Socket {
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
self.as_inner().fd()
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for old_io::net::tcp::TcpListener {
|
||||
fn as_raw_socket(&self) -> Socket {
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
self.as_inner().socket()
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for old_io::net::tcp::TcpAcceptor {
|
||||
fn as_raw_socket(&self) -> Socket {
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
self.as_inner().socket()
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(deprecated)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for old_io::net::udp::UdpSocket {
|
||||
fn as_raw_socket(&self) -> Socket {
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
self.as_inner().fd()
|
||||
}
|
||||
}
|
||||
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for net::TcpStream {
|
||||
fn as_raw_socket(&self) -> Socket { *self.as_inner().socket().as_inner() }
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
*self.as_inner().socket().as_inner()
|
||||
}
|
||||
}
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for net::TcpListener {
|
||||
fn as_raw_socket(&self) -> Socket { *self.as_inner().socket().as_inner() }
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
*self.as_inner().socket().as_inner()
|
||||
}
|
||||
}
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl AsRawSocket for net::UdpSocket {
|
||||
fn as_raw_socket(&self) -> Socket { *self.as_inner().socket().as_inner() }
|
||||
fn as_raw_socket(&self) -> RawSocket {
|
||||
*self.as_inner().socket().as_inner()
|
||||
}
|
||||
}
|
||||
|
||||
#[unstable(feature = "from_raw_os", reason = "trait is unstable")]
|
||||
impl FromRawSocket for net::TcpStream {
|
||||
fn from_raw_socket(sock: RawSocket) -> net::TcpStream {
|
||||
let sock = sys::net::Socket::from_inner(sock);
|
||||
net::TcpStream::from_inner(net2::TcpStream::from_inner(sock))
|
||||
}
|
||||
}
|
||||
#[unstable(feature = "from_raw_os", reason = "trait is unstable")]
|
||||
impl FromRawSocket for net::TcpListener {
|
||||
fn from_raw_socket(sock: RawSocket) -> net::TcpListener {
|
||||
let sock = sys::net::Socket::from_inner(sock);
|
||||
net::TcpListener::from_inner(net2::TcpListener::from_inner(sock))
|
||||
}
|
||||
}
|
||||
#[unstable(feature = "from_raw_os", reason = "trait is unstable")]
|
||||
impl FromRawSocket for net::UdpSocket {
|
||||
fn from_raw_socket(sock: RawSocket) -> net::UdpSocket {
|
||||
let sock = sys::net::Socket::from_inner(sock);
|
||||
net::UdpSocket::from_inner(net2::UdpSocket::from_inner(sock))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -230,7 +306,7 @@ pub mod fs {
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub mod prelude {
|
||||
#[doc(no_inline)]
|
||||
pub use super::io::{Socket, Handle, AsRawSocket, AsRawHandle};
|
||||
pub use super::io::{RawSocket, RawHandle, AsRawSocket, AsRawHandle};
|
||||
#[doc(no_inline)] #[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub use super::ffi::{OsStrExt, OsStringExt};
|
||||
#[doc(no_inline)]
|
||||
|
||||
@@ -20,11 +20,12 @@ use mem;
|
||||
use path::{Path, PathBuf};
|
||||
use ptr;
|
||||
use sync::Arc;
|
||||
use sys::handle::Handle as RawHandle;
|
||||
use sys::handle::Handle;
|
||||
use sys::{c, cvt};
|
||||
use sys_common::FromInner;
|
||||
use vec::Vec;
|
||||
|
||||
pub struct File { handle: RawHandle }
|
||||
pub struct File { handle: Handle }
|
||||
pub struct FileAttr { data: c::WIN32_FILE_ATTRIBUTE_DATA }
|
||||
|
||||
pub struct ReadDir {
|
||||
@@ -192,7 +193,7 @@ impl File {
|
||||
if handle == libc::INVALID_HANDLE_VALUE {
|
||||
Err(Error::last_os_error())
|
||||
} else {
|
||||
Ok(File { handle: RawHandle::new(handle) })
|
||||
Ok(File { handle: Handle::new(handle) })
|
||||
}
|
||||
}
|
||||
|
||||
@@ -260,7 +261,13 @@ impl File {
|
||||
Ok(newpos as u64)
|
||||
}
|
||||
|
||||
pub fn handle(&self) -> &RawHandle { &self.handle }
|
||||
pub fn handle(&self) -> &Handle { &self.handle }
|
||||
}
|
||||
|
||||
impl FromInner<libc::HANDLE> for File {
|
||||
fn from_inner(handle: libc::HANDLE) -> File {
|
||||
File { handle: Handle::new(handle) }
|
||||
}
|
||||
}
|
||||
|
||||
pub fn to_utf16(s: &Path) -> Vec<u16> {
|
||||
|
||||
@@ -19,7 +19,7 @@ use num::{SignedInt, Int};
|
||||
use rt;
|
||||
use sync::{Once, ONCE_INIT};
|
||||
use sys::c;
|
||||
use sys_common::AsInner;
|
||||
use sys_common::{AsInner, FromInner};
|
||||
|
||||
pub type wrlen_t = i32;
|
||||
|
||||
@@ -123,10 +123,14 @@ impl Socket {
|
||||
|
||||
impl Drop for Socket {
|
||||
fn drop(&mut self) {
|
||||
unsafe { cvt(libc::closesocket(self.0)).unwrap(); }
|
||||
let _ = unsafe { libc::closesocket(self.0) };
|
||||
}
|
||||
}
|
||||
|
||||
impl AsInner<libc::SOCKET> for Socket {
|
||||
fn as_inner(&self) -> &libc::SOCKET { &self.0 }
|
||||
}
|
||||
|
||||
impl FromInner<libc::SOCKET> for Socket {
|
||||
fn from_inner(sock: libc::SOCKET) -> Socket { Socket(sock) }
|
||||
}
|
||||
|
||||
@@ -31,7 +31,7 @@ use ptr;
|
||||
use slice;
|
||||
use sys::c;
|
||||
use sys::fs::FileDesc;
|
||||
use sys::handle::Handle as RawHandle;
|
||||
use sys::handle::Handle;
|
||||
|
||||
use libc::funcs::extra::kernel32::{
|
||||
GetEnvironmentStringsW,
|
||||
@@ -369,7 +369,7 @@ pub fn home_dir() -> Option<PathBuf> {
|
||||
if c::OpenProcessToken(me, c::TOKEN_READ, &mut token) == 0 {
|
||||
return None
|
||||
}
|
||||
let _handle = RawHandle::new(token);
|
||||
let _handle = Handle::new(token);
|
||||
super::fill_utf16_buf_new(|buf, mut sz| {
|
||||
match c::GetUserProfileDirectoryW(token, buf, &mut sz) {
|
||||
0 if libc::GetLastError() != 0 => 0,
|
||||
|
||||
Reference in New Issue
Block a user