Struct miow::iocp::CompletionStatus

#[repr(transparent)]
pub struct CompletionStatus(_);

A status message received from an I/O completion port.

These statuses can be created via the new or empty constructors and then provided to a completion port, or they are read out of a completion port. The fields of each status are read through its accessor methods.

Implementations

impl CompletionStatus

pub fn new(
    bytes: u32,
    token: usize,
    overlapped: *mut Overlapped
) -> CompletionStatus

Creates a new completion status with the provided parameters.

This function is useful when creating a status to send to a port with the post method. The parameters are opaquely passed through and not interpreted by the system at all.

pub fn from_entry(entry: &OVERLAPPED_ENTRY) -> &CompletionStatus

Creates a new borrowed completion status from the borrowed OVERLAPPED_ENTRY argument provided.

This method will wrap the OVERLAPPED_ENTRY in a CompletionStatus, returning the wrapped structure.

pub fn zero() -> CompletionStatus

Creates a new “zero” completion status.

This function is useful when creating a stack buffer or vector of completion statuses to be passed to the get_many function.

pub fn bytes_transferred(&self) -> u32

Returns the number of bytes that were transferred for the I/O operation associated with this completion status.

pub fn token(&self) -> usize

Returns the completion key value associated with the file handle whose I/O operation has completed.

A completion key is a per-handle key that is specified when it is added to an I/O completion port via add_handle or add_socket.

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

Returns a pointer to the Overlapped structure that was specified when the I/O operation was started.

pub fn entry(&self) -> &OVERLAPPED_ENTRY

Returns a pointer to the internal OVERLAPPED_ENTRY object.

Trait Implementations

impl Clone for CompletionStatus

fn clone(&self) -> CompletionStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompletionStatus

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

Formats the value using the given formatter.

impl Copy for CompletionStatus

impl Send for CompletionStatus

impl Sync for CompletionStatus