Backport the HandleOrInvalid patch from the PR.

Co-authored-by: Josh Triplett <[email protected]>

Author: sunfishcode

README.md

@@ -68,7 +68,7 @@ impl FromFd for OwnedFd { ... }
 ```
 
 On Windows, there are `Handle` and `Socket` versions of every `Fd` thing, and
-a special `OptionFileHandle` type to cope with inconsistent error reporting
+a special `HandleOrInvalid` type to cope with inconsistent error reporting
 in the Windows API.
 
 Full API documentation:

examples/hello.rs

@@ -69,7 +69,7 @@ fn main() -> io::Result<()> {
 #[cfg(windows)]
 fn main() -> io::Result<()> {
     let handle = unsafe {
-        // Open a file, which returns an `OptionFileHandle`, which we can fallibly
+        // Open a file, which returns an `HandleOrInvalid`, which we can fallibly
         // convert into an `OwnedFile`.
         let handle: OwnedHandle = CreateFileW(
             ['C' as u16, 'O' as _, 'N' as _, 0].as_ptr(),

src/example_ffi.rs

@@ -10,7 +10,7 @@
 #[cfg(any(unix, target_os = "wasi"))]
 use crate::{BorrowedFd, OwnedFd};
 #[cfg(windows)]
-use crate::{BorrowedHandle, OptionFileHandle, OwnedHandle};
+use crate::{BorrowedHandle, HandleOrInvalid, OwnedHandle};
 
 #[cfg(any(unix, target_os = "wasi"))]
 use libc::{c_char, c_int, c_void, size_t, ssize_t};
@@ -35,7 +35,7 @@ extern "C" {
 #[cfg(any(unix, target_os = "wasi"))]
 pub use libc::{O_CLOEXEC, O_CREAT, O_RDONLY, O_RDWR, O_TRUNC, O_WRONLY};
 
-/// The Windows analogs of the above. Note the use of [`OptionFileHandle`] as
+/// The Windows analogs of the above. Note the use of [`HandleOrInvalid`] as
 /// the return type for `CreateFileW`, since that function is defined to return
 /// [`INVALID_HANDLE_VALUE`] on error instead of null.
 #[cfg(windows)]
@@ -48,7 +48,7 @@ extern "C" {
         dwCreationDisposition: DWORD,
         dwFlagsAndAttributes: DWORD,
         hTemplateFile: HANDLE,
-    ) -> OptionFileHandle;
+    ) -> HandleOrInvalid;
     pub fn ReadFile(
         hFile: HANDLE,
         lpBuffer: LPVOID,

src/lib.rs

@@ -43,7 +43,7 @@ pub use traits::{AsHandle, AsSocket, FromHandle, FromSocket, IntoHandle, IntoSoc
 #[cfg(any(unix, target_os = "wasi"))]
 pub use types::{BorrowedFd, OwnedFd};
 #[cfg(windows)]
-pub use types::{BorrowedHandle, BorrowedSocket, OptionFileHandle, OwnedHandle, OwnedSocket};
+pub use types::{BorrowedHandle, BorrowedSocket, HandleOrInvalid, OwnedHandle, OwnedSocket};
 
 pub use portability::{
     AsFilelike, AsSocketlike, BorrowedFilelike, BorrowedSocketlike, FromFilelike, FromSocketlike,

src/traits.rs

@@ -1,7 +1,7 @@
 #[cfg(any(unix, target_os = "wasi"))]
 use crate::{BorrowedFd, OwnedFd};
 #[cfg(windows)]
-use crate::{BorrowedHandle, BorrowedSocket, OptionFileHandle, OwnedHandle, OwnedSocket};
+use crate::{BorrowedHandle, BorrowedSocket, HandleOrInvalid, OwnedHandle, OwnedSocket};
 #[cfg(unix)]
 use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd};
 #[cfg(target_os = "wasi")]
@@ -307,7 +307,7 @@ impl FromSocket for OwnedSocket {
 }
 
 #[cfg(windows)]
-impl FromHandle for OptionFileHandle {
+impl FromHandle for HandleOrInvalid {
     #[inline]
     fn from_handle(owned: OwnedHandle) -> Self {
         unsafe { Self::from_raw_handle(owned.into_raw_handle()) }