Struct Completion 

pub struct Completion { /* private fields */ }

A completion packet dequeued from a CompletionPort.

Dequeuing removes the operation from the port’s outstanding set, so holding a completion never blocks CompletionPort::run_down or the port’s Drop. The completion still owns the operation’s storage until it is dropped or claimed, and may outlive the port it came from.

Implementations

impl Completion

pub fn key(&self) -> usize

The completion key the packet was tagged with.

pub fn bytes_transferred(&self) -> u32

The number of bytes transferred by the operation.

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

The OVERLAPPED pointer identifying the completed operation.

For a user packet this is whatever value was passed to CompletionPort::post.

pub fn id(&self) -> Option<OperationId>

The identity of the operation this packet completes.

It matches the OperationId that AssociatedEndpoint::submit returned for the operation, so a caller holding submission-time identities can match a completion against them directly. Returns None for a user packet from CompletionPort::post, which completes no operation.

pub fn error(&self) -> Option<&Error>

The failure of the completed operation, if it did not succeed.

pub unsafe fn claim<P>(&self) -> Operation<P>

Recover the owned operation whose completion this is.

Safety

This completion must have been produced by submitting an Operation<P> of this exact type through AssociatedEndpoint::submit, and it must be claimed exactly once.

Trait Implementations

impl Debug for Completion

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

Formats the value using the given formatter.

impl Drop for Completion

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.