Struct TokioCompat 

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

Available on crate feature tokio-rt only.

Provides compatibility between objects implementing tokio’s async io traits and the corresponding traits defined by the futures crate.

Implementations

impl<T> TokioCompat<T>

pub fn new(inner: T) -> Self

Creates a new instance by wrapping the inner object.

pub fn get_ref(&self) -> &T

Get a reference to the wrapped object.

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

Get a mutable reference to the wrapped object.

pub fn into_inner(self) -> T

Consumes the TokioCompat object and returns the wrapped object.

Trait Implementations

impl<T> AsyncBufRead for TokioCompat<T>

where T: TokioAsyncBufRead + Unpin,

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

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 TokioCompat<T>

where T: TokioAsyncRead + Unpin,

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<T> AsyncSeek for TokioCompat<T>

where T: TokioAsyncSeek + Unpin,

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

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

impl<T> AsyncWrite for TokioCompat<T>

where T: TokioAsyncWrite + Unpin,

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.

impl File for TokioCompat<File>

fn open<'async_trait, P>( path: P, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait,

Opens a file in read-only mode.

fn create<'async_trait, P>( path: P, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait,

Opens a file in write-only mode.

fn sync_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Synchronizes OS-internal buffered contents and metadata to disk.

fn sync_data<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Synchronizes OS-internal buffered contents to disk.

fn set_len<'life0, 'async_trait>( &'life0 self, size: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Truncates or extends the file.

fn metadata<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Metadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads the file’s metadata.

fn set_permissions<'life0, 'async_trait>( &'life0 self, perm: Permissions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Changes the permissions on the file.

impl TcpStream for TokioCompat<TcpStream>

fn connect<'async_trait, A>( addrs: A, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where A: 'async_trait + ToSocketAddrs + Send, Self: 'async_trait,

Opens a TCP connection to a remote host.

fn peek<'life0, 'life1, 'async_trait>( &'life0 self, buf: &'life1 mut [u8], ) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue.

fn peer_addr(&self) -> Result<SocketAddr>

Returns the remote address that this stream is connected to.

fn local_addr(&self) -> Result<SocketAddr>

Returns the local address that this stream is connected to.

fn nodelay(&self) -> Result<bool>

Gets the value of the TCP_NODELAY option on this socket.

fn set_nodelay(&self, nodelay: bool) -> Result<()>

Sets the value of the TCP_NODELAY option on this socket.

fn ttl(&self) -> Result<u32>

Gets the value of the IP_TTL option for this socket.

fn set_ttl(&self, ttl: u32) -> Result<()>

Sets the value for the IP_TTL option on this socket.

impl UnixStream for TokioCompat<UnixStream>

Available on Unix only.

type SocketAddr = SocketAddr

fn connect<'async_trait, P>( path: P, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait,

Connects to the socket to the specified address.

fn pair() -> Result<(Self, Self)>

Creates an unnamed pair of connected sockets.

fn peer_addr(&self) -> Result<Self::SocketAddr>

Returns the socket address of the local half of this connection.

fn local_addr(&self) -> Result<Self::SocketAddr>

Returns the socket address of the remote half of this connection.