Enum tcp_stream::TcpStream

pub enum TcpStream {
    Plain(MioTcpStream, bool),
    NativeTls(Box<NativeTlsStream>),
    OpenSsl(Box<OpenSslStream>),
    Rustls(Box<RustlsStream>),
}

Wrapper around plain or TLS TCP streams

Variants

Plain(MioTcpStream, bool)

Wrapper around mio's TcpStream

NativeTls(Box<NativeTlsStream>)

Wrapper around a TLS stream hanled by native-tls

OpenSsl(Box<OpenSslStream>)

Wrapper around a TLS stream hanled by openssl

Rustls(Box<RustlsStream>)

Wrapper around a TLS stream hanled by rustls

Implementations

impl TcpStream

pub fn connect<A: ToSocketAddrs>(addr: A) -> Result<Self>

Wrapper around mio's TcpStream::connect inspired by std::net::TcpStream::connect

pub fn connect_timeout<A: ToSocketAddrs>(
    addr: A,
    timeout: Duration
) -> Result<Self>

Wrapper around mio's TcpStream::connect inspired by std::net::TcpStream::connect_timeout and std::net::TcpStream::connect. We used the timeout on the first SocketAddr.

pub fn from_std(stream: StdTcpStream) -> Result<Self>

Wrapper around mio's TcpStream::from_std

pub fn is_connected(&self) -> bool

Check whether the stream is connected or not

pub fn try_connect(&mut self) -> Result<bool>

Retry the connection. Returns:

• Ok(true) if connected
• Ok(false) if connecting
• Err(_) if an error is encountered

pub fn into_tls(
    self,
    domain: &str,
    config: TLSConfig<'_, '_, '_>
) -> Result<Self, HandshakeError>

Enable TLS

pub fn into_native_tls(
    self,
    connector: NativeTlsConnector,
    domain: &str
) -> Result<Self, HandshakeError>

Enable TLS using native-tls

pub fn into_openssl(
    self,
    connector: OpenSslConnector,
    domain: &str
) -> Result<Self, HandshakeError>

Enable TLS using openssl

pub fn into_rustls(
    self,
    connector: RustlsConnector,
    domain: &str
) -> Result<Self, HandshakeError>

Enable TLS using rustls

impl TcpStream

pub fn is_readable(&self) -> Result<()>

Attempt reading from underlying stream, returning Ok(()) if the stream is readable

pub fn is_writable(&self) -> Result<()>

Attempt writing to underlying stream, returning Ok(()) if the stream is writable

Methods from Deref<Target = MioTcpStream>

pub fn peer_addr(&self) -> Result<SocketAddr, Error>

Returns the socket address of the remote peer of this TCP connection.

pub fn local_addr(&self) -> Result<SocketAddr, Error>

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

pub fn shutdown(&self, how: Shutdown) -> Result<(), Error>

Shuts down the read, write, or both halves of this connection.

This function will cause all pending and future I/O on the specified portions to return immediately with an appropriate value (see the documentation of Shutdown).

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

Sets the value of the TCP_NODELAY option on this socket.

If set, this option disables the Nagle algorithm. This means that segments are always sent as soon as possible, even if there is only a small amount of data. When not set, data is buffered until there is a sufficient amount to send out, thereby avoiding the frequent sending of small packets.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to set nodelay on an unconnected TcpStream is undefined behavior.

pub fn nodelay(&self) -> Result<bool, Error>

Gets the value of the TCP_NODELAY option on this socket.

For more information about this option, see set_nodelay.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to get nodelay on an unconnected TcpStream is undefined behavior.

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

Sets the value for the IP_TTL option on this socket.

This value sets the time-to-live field that is used in every packet sent from this socket.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to set ttl on an unconnected TcpStream is undefined behavior.

pub fn ttl(&self) -> Result<u32, Error>

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to get ttl on an unconnected TcpStream is undefined behavior.

pub fn take_error(&self) -> Result<Option<Error>, Error>

Get the value of the SO_ERROR option on this socket.

This will retrieve the stored error in the underlying socket, clearing the field in the process. This can be useful for checking errors between calls.

pub fn peek(&self, buf: &mut [u8]) -> Result<usize, Error>

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.

Successive calls return the same data. This is accomplished by passing MSG_PEEK as a flag to the underlying recv system call.

Trait Implementations

impl AsRawFd for TcpStream

pub fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<'_> AsRawFd for &'_ TcpStream

pub fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl Deref for TcpStream

type Target = MioTcpStream

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TcpStream

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<SslStream<TcpStream>> for TcpStream

pub fn from(s: OpenSslStream) -> Self

Performs the conversion.

impl From<StreamOwned<ClientSession, TcpStream>> for TcpStream

pub fn from(s: RustlsStream) -> Self

Performs the conversion.

impl From<TcpStream> for MidHandshakeTlsStream

pub fn from(mid: TcpStream) -> Self

Performs the conversion.

impl From<TlsStream<TcpStream>> for TcpStream

pub fn from(s: NativeTlsStream) -> Self

Performs the conversion.

impl FromRawFd for TcpStream

pub unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl Read for TcpStream

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers.

pub fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

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

pub fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Source for TcpStream

pub fn register(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Register self with the given Registry instance.

pub fn reregister(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Re-register self with the given Registry instance.

pub fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister self from the given Registry instance.

impl TryFrom<TcpStream> for TcpStream

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(s: MioTcpStream) -> Result<Self>

Performs the conversion.

impl Write for TcpStream

pub fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

pub fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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

pub fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>

Writes a formatted string into this writer, returning any error encountered.

pub fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

pub fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.