Struct completion::MustComplete

pub struct MustComplete<T> { /* fields omitted */ }

Make sure that a future or stream will complete, created by CompletionFutureExt::must_complete and CompletionStreamExt::must_complete.

This wraps a CompletionFuture or CompletionStream and will ignore all requests to cancel it, enforcing that it will complete.

Implementations

impl<T> MustComplete<T>

pub unsafe fn into_inner(self) -> T

Take the inner item.

Safety

This value must not be cancelled with CompletionFuture::poll_cancel or CompletionStream::poll_cancel.

Trait Implementations

impl<T: Clone> Clone for MustComplete<T>

fn clone(&self) -> MustComplete<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: CompletionFuture> CompletionFuture for MustComplete<T>

type Output = T::Output

The type of value produced on completion.

unsafe fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

unsafe fn poll_cancel(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

Attempt to cancel the future, registering the current task for wakeup if has not finished cancelling yet.

impl<T: CompletionStream> CompletionStream for MustComplete<T>

type Item = T::Item

Values yielded by the stream.

unsafe fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

unsafe fn poll_cancel(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

Attempt to cancel the stream, registering the current task for wakeup if it has not finished cancelling yet.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<T: Debug> Debug for MustComplete<T>

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

Formats the value using the given formatter.

impl<'__pin, T> Unpin for MustComplete<T> where
    __Origin<'__pin, T>: Unpin,