Struct miow::iocp::CompletionStatus
[−]
[src]
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.
Methods
impl CompletionStatus[src]
fn new(bytes: u32,
token: usize,
overlapped: *mut Overlapped)
-> CompletionStatus
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.
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.
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.
fn bytes_transferred(&self) -> u32
Returns the number of bytes that were transferred for the I/O operation associated with this completion status.
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.
fn overlapped(&self) -> *mut Overlapped
Returns a pointer to the Overlapped structure that was specified when
the I/O operation was started.
fn entry(&self) -> &OVERLAPPED_ENTRY
Returns a pointer to the internal OVERLAPPED_ENTRY object.
Trait Implementations
impl Clone for CompletionStatus[src]
fn clone(&self) -> CompletionStatus
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0
Performs copy-assignment from source. Read more