Enum AnyTokioStream 

pub enum AnyTokioStream {
    Tcp(TcpStream),
    Unix(UnixStream),
}

A connected stream-type socket, either TCP or Unix-domain, adapted for use with tokio.

AnyTokioStreams are usually obtained from a call to AnyTokioListener::accept. This type implements AsyncRead and AsyncWrite, and is used to communicate with the connected peer in much the same way as a tokio::net::TcpStream.

Availability

All platforms, but the Unix variant is only available on Unix-like platforms. Converting a Unix-domain socket on Windows will result in an error.

Requires the tokio feature.

Variants

Tcp(TcpStream)

A connected TCP socket.

Availability

All platforms.

Unix(UnixStream)

A connected Unix-domain stream-type socket.

Availability

Unix-like platforms only. Tokio currently does not support Unix-domain sockets on Windows.

Implementations

impl AnyTokioStream

pub fn local_addr(&self) -> Result<SockAddr>

Returns the local address that this socket is bound to.

This method delegates to tokio::net::TcpStream::local_addr or tokio::net::UnixStream::local_addr, as appropriate.

pub fn peer_addr(&self) -> Result<SockAddr>

Returns the remote address that this socket is connected to.

This method delegates to tokio::net::TcpStream::peer_addr or tokio::net::UnixStream::peer_addr, as appropriate.

Trait Implementations

impl AsFd for AnyTokioStream

Available on non-Windows only.

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for AnyTokioStream

Available on non-Windows only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for AnyTokioStream

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

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for AnyTokioStream

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

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

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 Debug for AnyTokioStream

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

Formats the value using the given formatter.

impl From<TcpStream> for AnyTokioStream

fn from(original: TcpStream) -> AnyTokioStream

Converts to this type from the input type.

impl From<UnixStream> for AnyTokioStream

fn from(original: UnixStream) -> AnyTokioStream

Converts to this type from the input type.

impl TryFrom<AnyStdSocket> for AnyTokioStream

type Error = IntoTokioError

The type returned in the event of a conversion error.

fn try_from(socket: AnyStdSocket) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<AnyTokioStream> for Socket

type Error = Error

The type returned in the event of a conversion error.

fn try_from(socket: AnyTokioStream) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Socket> for AnyTokioStream

type Error = IntoTokioError

The type returned in the event of a conversion error.

fn try_from(socket: Socket) -> Result<Self, Self::Error>

Performs the conversion.

impl<'pin> Unpin for AnyTokioStream

where PinnedFieldsOf<__AnyTokioStream<'pin>>: Unpin,