Struct futures_util::compat::Compat01As03

#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Compat01As03<T> { /* fields omitted */ }

Converts a futures 0.1 Future, Stream, AsyncRead, or AsyncWrite object to a futures 0.3-compatible version,

Methods

impl<T> Compat01As03<T>

Important traits for Compat01As03<Fut>

impl<Fut: Future01> Future for Compat01As03<Fut> type Output = Result<Fut::Item, Fut::Error>;

pub fn new(object: T) -> Compat01As03<T>

Wraps a futures 0.1 Future, Stream, AsyncRead, or AsyncWrite object in a futures 0.3-compatible wrapper.

pub fn get_ref(&self) -> &T

Get a reference to 0.1 Future, Stream, AsyncRead, or AsyncWrite object contained within.

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to 0.1 Future, Stream, AsyncRead or AsyncWrite object contained within.

pub fn into_inner(self) -> T

Consume this wrapper to return the underlying 0.1 Future, Stream, AsyncRead, or AsyncWrite object.

Trait Implementations

impl<T> Unpin for Compat01As03<T>

impl<T: Debug> Debug for Compat01As03<T>

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

Formats the value using the given formatter.

impl<Fut: Future01> Future for Compat01As03<Fut>

type Output = Result<Fut::Item, Fut::Error>

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<St: Stream01> Stream for Compat01As03<St>

type Item = Result<St::Item, St::Error>

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.

impl<R: AsyncRead01> AsyncRead for Compat01As03<R>

unsafe fn initializer(&self) -> Initializer

Determines if this AsyncReader can work with buffers of uninitialized memory.

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<W: AsyncWrite01> AsyncWrite for Compat01As03<W>

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.