Struct async_tls::TlsConnector

pub struct TlsConnector { /* fields omitted */ }

The TLS connecting part. The acceptor drives the client side of the TLS handshake process. It works on any asynchronous stream.

It provides a simple interface (connect), returning a future that will resolve when the handshake process completed. On success, it will hand you an async TlsStream.

To create a TlsConnector with a non-default configuation, create a rusttls::ClientConfig and call .into() on it.

Example

use async_tls::TlsConnector;

async_std::task::block_on(async {
    let connector = TlsConnector::default();
    let tcp_stream = async_std::net::TcpStream::connect("example.com").await?;
    let encrypted_stream = connector.connect("example.com", tcp_stream).await?;

    Ok(()) as async_std::io::Result<()>
});

Implementations

impl TlsConnector

pub fn new() -> Self

Create a new TlsConnector with default configuration.

This is the same as calling TlsConnector::default().

pub fn connect<'a, IO>(
    &self,
    domain: impl AsRef<str>,
    stream: IO
) -> Connect<IO> where
    IO: AsyncRead + AsyncWrite + Unpin, 

Connect to a server. stream can be any type implementing AsyncRead and AsyncWrite, such as TcpStreams or Unix domain sockets.

The function will return a Connect Future, representing the connecting part of a Tls handshake. It will resolve when the handshake is over.

Trait Implementations

impl Clone for TlsConnector

fn clone(&self) -> TlsConnector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TlsConnector

fn default() -> Self

Returns the "default value" for a type.

impl From<Arc<ClientConfig>> for TlsConnector

fn from(inner: Arc<ClientConfig>) -> TlsConnector

Performs the conversion.

impl From<ClientConfig> for TlsConnector

fn from(inner: ClientConfig) -> TlsConnector

Performs the conversion.