Struct completion::AssertCompletes

#[must_use = "futures and streams do nothing unless you use them"]pub struct AssertCompletes<T> { /* fields omitted */ }

Unsafely assert that the inner future or stream will complete.

This will wrap a CompletionFuture or CompletionStream and implement Future or Stream for it respectively.

It can be used in conjunction with MustComplete to apply Future-only combinators to CompletionFutures.

Implementations

impl<T> AssertCompletes<T>

pub unsafe fn new(inner: T) -> Self

Create a new AssertCompletes around a future or stream that must complete.

Safety

This future or stream, once polled, must be polled to completion.

pub fn into_inner(self) -> T

Take the inner item.

Trait Implementations

impl<T: Clone> Clone for AssertCompletes<T>

fn clone(&self) -> AssertCompletes<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 AssertCompletes<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 AssertCompletes<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 AssertCompletes<T>

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

Formats the value using the given formatter.

impl<T> Deref for AssertCompletes<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for AssertCompletes<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: CompletionFuture> Future for AssertCompletes<T>

type Output = T::Output

The type of value produced on completion.

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.

impl<T: CompletionStream> Stream for AssertCompletes<T>

type Item = T::Item

Values yielded by the stream.

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.

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

Returns the bounds on the remaining length of the stream.

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