#![unstable(issue = "none", feature = "windows_handle")] use crate::cmp; use crate::io::{self, ErrorKind, IoSlice, IoSliceMut, Read}; use crate::mem; use crate::os::windows::io::{ AsHandle, AsRawHandle, BorrowedHandle, FromRawHandle, IntoRawHandle, OwnedHandle, RawHandle, }; use crate::ptr; use crate::sys::c; use crate::sys::cvt; use crate::sys_common::{AsInner, FromInner, IntoInner}; /// An owned container for `HANDLE` object, closing them on Drop. /// /// All methods are inherited through a `Deref` impl to `RawHandle` pub struct Handle(OwnedHandle); impl Handle { pub fn new_event(manual: bool, init: bool) -> io::Result { unsafe { let event = c::CreateEventW(ptr::null_mut(), manual as c::BOOL, init as c::BOOL, ptr::null()); if event.is_null() { Err(io::Error::last_os_error()) } else { Ok(Handle::from_raw_handle(event)) } } } } impl AsInner for Handle { fn as_inner(&self) -> &OwnedHandle { &self.0 } } impl IntoInner for Handle { fn into_inner(self) -> OwnedHandle { self.0 } } impl FromInner for Handle { fn from_inner(file_desc: OwnedHandle) -> Self { Self(file_desc) } } impl AsHandle for Handle { fn as_handle(&self) -> BorrowedHandle<'_> { self.0.as_handle() } } impl AsRawHandle for Handle { fn as_raw_handle(&self) -> RawHandle { self.0.as_raw_handle() } } impl IntoRawHandle for Handle { fn into_raw_handle(self) -> RawHandle { self.0.into_raw_handle() } } impl FromRawHandle for Handle { unsafe fn from_raw_handle(raw_handle: RawHandle) -> Self { Self(FromRawHandle::from_raw_handle(raw_handle)) } } impl Handle { pub fn read(&self, buf: &mut [u8]) -> io::Result { let mut read = 0; let len = cmp::min(buf.len(), ::MAX as usize) as c::DWORD; let res = cvt(unsafe { c::ReadFile( self.as_raw_handle(), buf.as_mut_ptr() as c::LPVOID, len, &mut read, ptr::null_mut(), ) }); match res { Ok(_) => Ok(read as usize), // The special treatment of BrokenPipe is to deal with Windows // pipe semantics, which yields this error when *reading* from // a pipe after the other end has closed; we interpret that as // EOF on the pipe. Err(ref e) if e.kind() == ErrorKind::BrokenPipe => Ok(0), Err(e) => Err(e), } } pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result { crate::io::default_read_vectored(|buf| self.read(buf), bufs) } #[inline] pub fn is_read_vectored(&self) -> bool { false } pub fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result { let mut read = 0; let len = cmp::min(buf.len(), ::MAX as usize) as c::DWORD; let res = unsafe { let mut overlapped: c::OVERLAPPED = mem::zeroed(); overlapped.Offset = offset as u32; overlapped.OffsetHigh = (offset >> 32) as u32; cvt(c::ReadFile( self.as_raw_handle(), buf.as_mut_ptr() as c::LPVOID, len, &mut read, &mut overlapped, )) }; match res { Ok(_) => Ok(read as usize), Err(ref e) if e.raw_os_error() == Some(c::ERROR_HANDLE_EOF as i32) => Ok(0), Err(e) => Err(e), } } pub unsafe fn read_overlapped( &self, buf: &mut [u8], overlapped: *mut c::OVERLAPPED, ) -> io::Result> { let len = cmp::min(buf.len(), ::MAX as usize) as c::DWORD; let mut amt = 0; let res = cvt(c::ReadFile( self.as_raw_handle(), buf.as_ptr() as c::LPVOID, len, &mut amt, overlapped, )); match res { Ok(_) => Ok(Some(amt as usize)), Err(e) => { if e.raw_os_error() == Some(c::ERROR_IO_PENDING as i32) { Ok(None) } else if e.raw_os_error() == Some(c::ERROR_BROKEN_PIPE as i32) { Ok(Some(0)) } else { Err(e) } } } } pub fn overlapped_result( &self, overlapped: *mut c::OVERLAPPED, wait: bool, ) -> io::Result { unsafe { let mut bytes = 0; let wait = if wait { c::TRUE } else { c::FALSE }; let res = cvt(c::GetOverlappedResult(self.as_raw_handle(), overlapped, &mut bytes, wait)); match res { Ok(_) => Ok(bytes as usize), Err(e) => { if e.raw_os_error() == Some(c::ERROR_HANDLE_EOF as i32) || e.raw_os_error() == Some(c::ERROR_BROKEN_PIPE as i32) { Ok(0) } else { Err(e) } } } } } pub fn cancel_io(&self) -> io::Result<()> { unsafe { cvt(c::CancelIo(self.as_raw_handle())).map(drop) } } pub fn write(&self, buf: &[u8]) -> io::Result { let mut amt = 0; let len = cmp::min(buf.len(), ::MAX as usize) as c::DWORD; cvt(unsafe { c::WriteFile( self.as_raw_handle(), buf.as_ptr() as c::LPVOID, len, &mut amt, ptr::null_mut(), ) })?; Ok(amt as usize) } pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result { crate::io::default_write_vectored(|buf| self.write(buf), bufs) } #[inline] pub fn is_write_vectored(&self) -> bool { false } pub fn write_at(&self, buf: &[u8], offset: u64) -> io::Result { let mut written = 0; let len = cmp::min(buf.len(), ::MAX as usize) as c::DWORD; unsafe { let mut overlapped: c::OVERLAPPED = mem::zeroed(); overlapped.Offset = offset as u32; overlapped.OffsetHigh = (offset >> 32) as u32; cvt(c::WriteFile( self.as_raw_handle(), buf.as_ptr() as c::LPVOID, len, &mut written, &mut overlapped, ))?; } Ok(written as usize) } pub fn duplicate( &self, access: c::DWORD, inherit: bool, options: c::DWORD, ) -> io::Result { let mut ret = 0 as c::HANDLE; cvt(unsafe { let cur_proc = c::GetCurrentProcess(); c::DuplicateHandle( cur_proc, self.as_raw_handle(), cur_proc, &mut ret, access, inherit as c::BOOL, options, ) })?; unsafe { Ok(Handle::from_raw_handle(ret)) } } } impl<'a> Read for &'a Handle { fn read(&mut self, buf: &mut [u8]) -> io::Result { (**self).read(buf) } fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> io::Result { (**self).read_vectored(bufs) } }