Struct miow::Overlapped

pub struct Overlapped(_);

A wrapper around OVERLAPPED to provide “rustic” accessors and initializers.

Implementations

impl Overlapped

pub fn zero() -> Overlapped

Creates a new zeroed out instance of an overlapped I/O tracking state.

This is suitable for passing to methods which will then later get notified via an I/O Completion Port.

pub fn initialize_with_autoreset_event() -> Result<Overlapped>

Creates a new Overlapped with an initialized non-null hEvent. The caller is responsible for calling CloseHandle on the hEvent field of the returned Overlapped. The event is created with bManualReset set to FALSE, meaning after a single thread waits on the event, it will be reset.

pub unsafe fn from_raw<'a>(ptr: *mut OVERLAPPED) -> &'a mut Overlapped

Creates a new Overlapped function pointer from the underlying OVERLAPPED, wrapping in the “rusty” wrapper for working with accessors.

Unsafety

This function doesn’t validate ptr nor the lifetime of the returned pointer at all, it’s recommended to use this method with extreme caution.

pub fn raw(&self) -> *mut OVERLAPPED

Gain access to the raw underlying data

pub fn set_offset(&mut self, offset: u64)

Sets the offset inside this overlapped structure.

Note that for I/O operations in general this only has meaning for I/O handles that are on a seeking device that supports the concept of an offset.

pub fn offset(&self) -> u64

Reads the offset inside this overlapped structure.

pub fn set_event(&mut self, event: HANDLE)

Sets the hEvent field of this structure.

The event specified can be null.

pub fn event(&self) -> HANDLE

Reads the hEvent field of this structure, may return null.

Trait Implementations

impl Debug for Overlapped

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Send for Overlapped

impl Sync for Overlapped