Skip to content

Commit

Permalink
Update the documentation for {As,Into,From}Raw{Fd,Handle,Socket}
Browse files Browse the repository at this point in the history
This ports the changes proposed in rust-lang/rust#93562 to io-lifetimes.

Specifically, remove the redundant comments on
`OwnedHandle::from_raw_handle` and `OwnedSocket::from_raw_socket`, and
remove the `FromRawHandle` impls for `HandleOrInvalid` and `HandleOrNull`.
  • Loading branch information
sunfishcode committed Feb 3, 2022
1 parent ffc0e79 commit 20ae4da
Showing 1 changed file with 11 additions and 23 deletions.
34 changes: 11 additions & 23 deletions src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -399,12 +399,6 @@ impl FromRawFd for OwnedFd {

#[cfg(windows)]
impl FromRawHandle for OwnedHandle {
/// Constructs a new instance of `Self` from the given raw handle.
///
/// # Safety
///
/// The resource pointed to by `raw` must be open and suitable for assuming
/// ownership.
#[inline]
unsafe fn from_raw_handle(handle: RawHandle) -> Self {
Self { handle }
Expand All @@ -413,12 +407,6 @@ impl FromRawHandle for OwnedHandle {

#[cfg(windows)]
impl FromRawSocket for OwnedSocket {
/// Constructs a new instance of `Self` from the given raw socket.
///
/// # Safety
///
/// The resource pointed to by `raw` must be open and suitable for assuming
/// ownership.
#[inline]
unsafe fn from_raw_socket(socket: RawSocket) -> Self {
debug_assert_ne!(socket, INVALID_SOCKET as RawSocket);
Expand All @@ -427,7 +415,7 @@ impl FromRawSocket for OwnedSocket {
}

#[cfg(windows)]
impl FromRawHandle for HandleOrInvalid {
impl HandleOrInvalid {
/// Constructs a new instance of `Self` from the given `RawHandle` returned
/// from a Windows API that uses `INVALID_HANDLE_VALUE` to indicate
/// failure, such as `CreateFileW`.
Expand All @@ -437,20 +425,20 @@ impl FromRawHandle for HandleOrInvalid {
///
/// # Safety
///
/// The resource pointed to by `handle` must be either open and otherwise
/// unowned, null, or equal to `INVALID_HANDLE_VALUE` (-1). Note that not
/// all Windows APIs use `INVALID_HANDLE_VALUE` for errors; see [here] for
/// the full story.
/// The passed `handle` value must either satisfy the safety requirements
/// of [`FromRawHandle::from_raw_handle`], or be
/// `INVALID_HANDLE_VALUE` (-1). Note that not all Windows APIs use
/// `INVALID_HANDLE_VALUE` for errors; see [here] for the full story.
///
/// [here]: https://devblogs.microsoft.com/oldnewthing/20040302-00/?p=40443
#[inline]
unsafe fn from_raw_handle(handle: RawHandle) -> Self {
pub unsafe fn from_raw_handle(handle: RawHandle) -> Self {
Self(handle)
}
}

#[cfg(windows)]
impl FromRawHandle for HandleOrNull {
impl HandleOrNull {
/// Constructs a new instance of `Self` from the given `RawHandle` returned
/// from a Windows API that uses null to indicate failure, such as
/// `CreateThread`.
Expand All @@ -460,13 +448,13 @@ impl FromRawHandle for HandleOrNull {
///
/// # Safety
///
/// The resource pointed to by `handle` must be either open and otherwise
/// unowned, or null. Note that not all Windows APIs use null for errors;
/// see [here] for the full story.
/// The passed `handle` value must either satisfy the safety requirements
/// of [`FromRawHandle::from_raw_handle`], or be null. Note that not all
/// Windows APIs use null for errors; see [here] for the full story.
///
/// [here]: https://devblogs.microsoft.com/oldnewthing/20040302-00/?p=40443
#[inline]
unsafe fn from_raw_handle(handle: RawHandle) -> Self {
pub unsafe fn from_raw_handle(handle: RawHandle) -> Self {
Self(handle)
}
}
Expand Down

0 comments on commit 20ae4da

Please sign in to comment.