Enum Started 

pub enum Started<T, P> {
    Pending(T),
    Completed {
        payload: P,
        bytes_transferred: usize,
    },
}

What became of an adapter submission that did not fail immediately.

This is crate::Submitted as an adapter reports it: the Failed arm is folded into the enclosing io::Result’s Err, and the operation storage of a synchronous completion is already reduced to the payload the matching token’s claim would have yielded, so the two arms report the same shape.

Variants

Pending(T)

The operation is in flight and a completion will arrive for it. Claim its result with the token, which also carries the operation’s identity for cancellation and matching.

Completed

The operation finished synchronously and no completion will arrive, so there is nothing to claim and its payload is returned directly.

Only reachable on an endpoint in FILE_SKIP_COMPLETION_PORT_ON_SUCCESS mode; an endpoint left in the default mode always reports Started::Pending, because the I/O Manager queues a packet even for an immediate success.

Fields

payload: P

The buffers the operation owned – the same payload the token’s claim yields on the pending path.

bytes_transferred: usize

The byte count the native call reported.

Implementations

impl<T, P> Started<T, P>

pub fn is_pending(&self) -> bool

Whether a completion will arrive for this operation.

pub fn is_completed(&self) -> bool

Whether the operation already finished with no completion to come.

pub fn pending(self) -> Option<T>

The token, if a completion will arrive.

pub fn completed(self) -> Option<(P, usize)>

The payload and byte count, if the operation already finished.

pub fn expect_pending(self, message: &str) -> T

The token, panicking if the operation completed synchronously.

For a caller that never puts its endpoints in FILE_SKIP_COMPLETION_PORT_ON_SUCCESS mode, where the synchronous arm is unreachable and matching on it is noise.

Panics

Panics with message if the operation completed synchronously, which means the endpoint was in skip-on-success mode after all.

Trait Implementations

impl<T: Debug, P: Debug> Debug for Started<T, P>

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

Formats the value using the given formatter.