Struct completion::Adapter

pub struct Adapter<T>(pub T);

Helper type to implement CompletionFuture or CompletionStream for a type that only implements Future or Stream.

This is typically created through the FutureExt::into_completion and StreamExt::into_completion methods.

Examples

// This future doesn't implement `CompletionFuture`, so to use it in `block_on` we need to wrap
// it in Adapter.
let future = async {};
completion::future::block_on(completion::Adapter(future));

Implementations

impl<T> Adapter<T>

#[must_use]pub fn get_pin_ref(self: Pin<&Self>) -> Pin<&T>

Get a pinned shared reference to the inner future or stream.

#[must_use]pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Get a pinned mutable reference to the inner future or stream.

Trait Implementations

impl<T: Clone> Clone for Adapter<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Future> CompletionFuture for Adapter<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: Stream> CompletionStream for Adapter<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 Adapter<T>

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

Formats the value using the given formatter.

impl<T: Future> Future for Adapter<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: Stream> Stream for Adapter<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.