Struct TlsStream

pub struct TlsStream<S: UnderlyingStream> { /* private fields */ }

An async stream that wraps a rustls connection and a TCP socket.

Implementations

impl TlsStream<TcpStream>

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

pub fn set_linger(&self, dur: Option<Duration>) -> Result<(), Error>

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

Returns the peer address of this socket.

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

Returns the local address of this socket.

impl TlsStream<UnixStream>

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

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

impl<S: UnderlyingStream + 'static> TlsStream<S>

pub fn new_client_side( tcp: S, tls: ClientConnection, buffer_size: Option<NonZeroUsize>, ) -> Self

pub fn new_client_side_from( tcp: S, connection: ClientConnection, buffer_size: Option<NonZeroUsize>, ) -> Self

pub fn new_server_side( tcp: S, tls_config: Arc<ServerConfig>, buffer_size: Option<NonZeroUsize>, ) -> Self

pub fn new_server_side_acceptor( tcp: S, server_config_provider: ServerConfigProvider, buffer_size: Option<NonZeroUsize>, ) -> Self

Create a server-side TLS connection that provides the ServerConfig dynamically based on the ClientHello message. This may be used to provide a different server certificate or ALPN configuration depending on the requested hostname.

pub fn new_server_side_from_acceptor( acceptor: Acceptor, tcp: S, server_config_provider: ServerConfigProvider, buffer_size: Option<NonZeroUsize>, ) -> Self

Create a server-side TLS connection that provides the ServerConfig dynamically based on the ClientHello message. This may be used to provide a different server certificate or ALPN configuration depending on the requested hostname.

This allows the caller to provide an Acceptor which may be non-default in some way, perhaps stuffed with prefix bytes or a full handshake to emulate.

pub fn new_server_side_from( tcp: S, connection: ServerConnection, buffer_size: Option<NonZeroUsize>, ) -> Self

pub fn try_into_inner(self) -> Result<(S, Connection), Self>

Attempt to retrieve the inner stream and connection.

pub fn into_split(self) -> (TlsStreamRead<S>, TlsStreamWrite<S>)

pub fn connection(&self) -> Option<&Connection>

If the stream is open, returns the underlying rustls connection.

pub async fn into_inner(self) -> Result<(S, Connection)>

pub fn poll_handshake( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<TlsHandshake>>

pub async fn handshake(&mut self) -> Result<TlsHandshake>

pub fn try_handshake(&self) -> Result<Option<TlsHandshake>>

Try to get the handshake, if one exists.

pub async fn close(self) -> Result<()>

impl<S: UnderlyingStream> TlsStream<S>

pub fn underlying_stream(&self) -> Option<&S>

If the stream is open or handshaking, returns the underlying TCP stream.

Trait Implementations

impl<S: UnderlyingStream> AsyncRead for TlsStream<S>

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

Attempts to read from the AsyncRead into buf.

impl<S: UnderlyingStream> AsyncWrite for TlsStream<S>

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_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 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 is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

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.

impl<S: UnderlyingStream> Debug for TlsStream<S>

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

Formats the value using the given formatter.

impl<S: UnderlyingStream> Drop for TlsStream<S>

fn drop(&mut self)

Executes the destructor for this type.