Struct tokio_util::compat::Compat

pub struct Compat<T> { /* private fields */ }

A compatibility layer that allows conversion between the tokio::io and futures-io AsyncRead and AsyncWrite traits.

Implementations

impl<T> Compat<T>

pub fn get_ref(&self) -> &T

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

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

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

pub fn into_inner(self) -> T

Returns the wrapped item.

Trait Implementations

impl<T: AsRawFd> AsRawFd for Compat<T>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<T> AsyncBufRead for Compat<T>where
    T: AsyncBufRead,

fn poll_fill_buf<'a>(
    self: Pin<&'a mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<&'a [u8]>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<T> AsyncBufRead for Compat<T>where
    T: AsyncBufRead,

fn poll_fill_buf<'a>(
    self: Pin<&'a mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<&'a [u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<T> AsyncRead for Compat<T>where
    T: AsyncRead,

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<T> AsyncRead for Compat<T>where
    T: AsyncRead,

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

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<T: AsyncSeek> AsyncSeek for Compat<T>

fn poll_seek(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    pos: SeekFrom
) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<T: AsyncSeek> AsyncSeek for Compat<T>

fn start_seek(self: Pin<&mut Self>, pos: SeekFrom) -> Result<()>

Attempts to seek to an offset, in bytes, in a stream.

fn poll_complete(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<u64>>

Waits for a seek operation to complete.

impl<T> AsyncWrite for Compat<T>where
    T: AsyncWrite,

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

Attempt to write bytes from buf into the object.

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

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<T> AsyncWrite for Compat<T>where
    T: AsyncWrite,

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

Attempt to write bytes from buf into the object.

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

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<()>>

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.

impl<T: Clone> Clone for Compat<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Compat<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Compat<T>

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