Fork the parts of winapi_util we need.

This forks the parts of winapi_util that winx needs, applying the
BurntSushi/winapi-util#13 patch which updates it to windows-sys.

Cargo.toml

@@ -25,6 +25,7 @@ features = [
     "Win32_System_LibraryLoader",
     "Win32_System_Performance",
     "Win32_System_SystemServices",
+    "Win32_System_WindowsProgramming",
 ]
 
 [package.metadata.docs.rs]

src/lib.rs

@@ -28,3 +28,4 @@ mod cvt;
 pub mod file;
 mod ntdll;
 pub mod time;
+pub mod winapi_util;

src/winapi_util/file.rs

@@ -0,0 +1,171 @@
+//! This file is derived from winapi_util's src/file.rs at
+//! revision 8f291c9da272b24699f31e22c521404255462642.
+//!
+//! It is ported to windows_sys and io-lifetimes.
+
+use std::io;
+use std::mem;
+use std::os::windows::io::AsRawHandle;
+
+use io_lifetimes::AsHandle;
+use windows_sys::Win32::Foundation::HANDLE;
+use windows_sys::Win32::Foundation::{GetLastError, FILETIME, NO_ERROR};
+use windows_sys::Win32::Storage::FileSystem::{
+    GetFileInformationByHandle, GetFileType, BY_HANDLE_FILE_INFORMATION, FILE_ATTRIBUTE_HIDDEN,
+};
+
+/// Return various pieces of information about a file.
+///
+/// This includes information such as a file's size, unique identifier and
+/// time related fields.
+///
+/// This corresponds to calling [`GetFileInformationByHandle`].
+///
+/// [`GetFileInformationByHandle`]: https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-getfileinformationbyhandle
+pub fn information<H: AsHandle>(h: H) -> io::Result<Information> {
+    unsafe {
+        let mut info: BY_HANDLE_FILE_INFORMATION = mem::zeroed();
+        let rc = GetFileInformationByHandle(h.as_handle().as_raw_handle() as HANDLE, &mut info);
+        if rc == 0 {
+            return Err(io::Error::last_os_error());
+        };
+        Ok(Information(info))
+    }
+}
+
+/// Returns the file type of the given handle.
+///
+/// If there was a problem querying the file type, then an error is returned.
+///
+/// This corresponds to calling [`GetFileType`].
+///
+/// [`GetFileType`]: https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-getfiletype
+pub fn typ<H: AsHandle>(h: H) -> io::Result<Type> {
+    unsafe {
+        let rc = GetFileType(h.as_handle().as_raw_handle() as HANDLE);
+        if rc == 0 && GetLastError() != NO_ERROR {
+            return Err(io::Error::last_os_error());
+        }
+        Ok(Type(rc))
+    }
+}
+
+/// Returns true if and only if the given file attributes contain the
+/// `FILE_ATTRIBUTE_HIDDEN` attribute.
+pub fn is_hidden(file_attributes: u64) -> bool {
+    file_attributes & (FILE_ATTRIBUTE_HIDDEN as u64) > 0
+}
+
+/// Represents file information such as creation time, file size, etc.
+///
+/// This wraps a [`BY_HANDLE_FILE_INFORMATION`].
+///
+/// [`BY_HANDLE_FILE_INFORMATION`]: https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/ns-fileapi-_by_handle_file_information
+#[derive(Clone)]
+pub struct Information(BY_HANDLE_FILE_INFORMATION);
+
+impl Information {
+    /// Returns file attributes.
+    ///
+    /// This corresponds to `dwFileAttributes`.
+    pub fn file_attributes(&self) -> u64 {
+        self.0.dwFileAttributes as u64
+    }
+
+    /// Returns true if and only if this file information has the
+    /// `FILE_ATTRIBUTE_HIDDEN` attribute.
+    pub fn is_hidden(&self) -> bool {
+        is_hidden(self.file_attributes())
+    }
+
+    /// Return the creation time, if one exists.
+    ///
+    /// This corresponds to `ftCreationTime`.
+    pub fn creation_time(&self) -> Option<u64> {
+        filetime_to_u64(self.0.ftCreationTime)
+    }
+
+    /// Return the last access time, if one exists.
+    ///
+    /// This corresponds to `ftLastAccessTime`.
+    pub fn last_access_time(&self) -> Option<u64> {
+        filetime_to_u64(self.0.ftLastAccessTime)
+    }
+
+    /// Return the last write time, if one exists.
+    ///
+    /// This corresponds to `ftLastWriteTime`.
+    pub fn last_write_time(&self) -> Option<u64> {
+        filetime_to_u64(self.0.ftLastWriteTime)
+    }
+
+    /// Return the serial number of the volume that the file is on.
+    ///
+    /// This corresponds to `dwVolumeSerialNumber`.
+    pub fn volume_serial_number(&self) -> u64 {
+        self.0.dwVolumeSerialNumber as u64
+    }
+
+    /// Return the file size, in bytes.
+    ///
+    /// This corresponds to `nFileSizeHigh` and `nFileSizeLow`.
+    pub fn file_size(&self) -> u64 {
+        ((self.0.nFileSizeHigh as u64) << 32) | (self.0.nFileSizeLow as u64)
+    }
+
+    /// Return the number of links to this file.
+    ///
+    /// This corresponds to `nNumberOfLinks`.
+    pub fn number_of_links(&self) -> u64 {
+        self.0.nNumberOfLinks as u64
+    }
+
+    /// Return the index of this file. The index of a file is a purpotedly
+    /// unique identifier for a file within a particular volume.
+    pub fn file_index(&self) -> u64 {
+        ((self.0.nFileIndexHigh as u64) << 32) | (self.0.nFileIndexLow as u64)
+    }
+}
+
+/// Represents a Windows file type.
+///
+/// This wraps the result of [`GetFileType`].
+///
+/// [`GetFileType`]: https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-getfiletype
+#[derive(Clone)]
+pub struct Type(u32);
+
+impl Type {
+    /// Returns true if this type represents a character file, which is
+    /// typically an LPT device or a console.
+    pub fn is_char(&self) -> bool {
+        self.0 == ::windows_sys::Win32::System::WindowsProgramming::FILE_TYPE_CHAR
+    }
+
+    /// Returns true if this type represents a disk file.
+    pub fn is_disk(&self) -> bool {
+        self.0 == ::windows_sys::Win32::System::WindowsProgramming::FILE_TYPE_DISK
+    }
+
+    /// Returns true if this type represents a sock, named pipe or an
+    /// anonymous pipe.
+    pub fn is_pipe(&self) -> bool {
+        self.0 == ::windows_sys::Win32::System::WindowsProgramming::FILE_TYPE_PIPE
+    }
+
+    /// Returns true if this type is not known.
+    ///
+    /// Note that this never corresponds to a failure.
+    pub fn is_unknown(&self) -> bool {
+        self.0 == ::windows_sys::Win32::System::WindowsProgramming::FILE_TYPE_UNKNOWN
+    }
+}
+
+fn filetime_to_u64(t: FILETIME) -> Option<u64> {
+    let v = ((t.dwHighDateTime as u64) << 32) | (t.dwLowDateTime as u64);
+    if v == 0 {
+        None
+    } else {
+        Some(v)
+    }
+}

src/winapi_util/mod.rs

@@ -0,0 +1,9 @@
+//! A port of selected [`winapi_util`] code to windows-sys and io-lifetimes.
+//!
+//! I have submitted a PR to propose incorporating the main changes here
+//! upstream in winapi_util, though there are some underlying logistical
+//! constraints, so it may not be a desirable change, or may take a while.
+//!
+//! [`winapi_util`]: https://crates.io/crates/winapi_util
+
+pub mod file;