Struct connect::Connection

pub struct Connection { /* fields omitted */ }

Wrapper around a ConnectionReader and ConnectionWriter to read and write on a network connection.

Implementations

impl Connection

pub async fn tcp_client<A: ToSocketAddrs + Display>(ip_addrs: A) -> Result<Self>

Creates a Connection that uses a TCP transport.

Example

Please see the tcp-client example program for a more thorough showcase.

Basic usage:

let mut conn = Connection::tcp_client("127.0.0.1:3456").await?;

impl Connection

pub async fn tls_client<A: ToSocketAddrs + Display>(
    ip_addrs: A,
    domain: &str,
    connector: TlsConnector
) -> Result<Self>

Creates a Connection that uses a TLS transport.

Example

Please see the tls-client example program for a more thorough showcase.

Basic usage:

let mut conn = Connection::tls_client("127.0.0.1:3456", "localhost", client_config.into()).await?;

impl Connection

pub fn local_addr(&self) -> SocketAddr

Get the local IP address and port.

pub fn peer_addr(&self) -> SocketAddr

Get the peer IP address and port.

pub fn split(self) -> (ConnectionReader, ConnectionWriter)

Consume the Connection to split into separate ConnectionReader and ConnectionWriter halves.

Connections are split when reading and writing must be concurrent operations.

pub fn join(reader: ConnectionReader, writer: ConnectionWriter) -> Self

Re-wrap the ConnectionReader and ConnectionWriter halves into a Connection.

pub fn reader(&mut self) -> &mut ConnectionReader

Get mutable access to the underlying ConnectionReader.

pub fn writer(&mut self) -> &mut ConnectionWriter

Get mutable access to the underlying ConnectionWriter.

pub async fn close(self) -> SocketAddr

Close the connection by closing both the reading and writing halves.

Trait Implementations

impl From<TcpStream> for Connection

fn from(stream: TcpStream) -> Self

Creates a Connection using a TCP transport from an async TcpStream.

impl From<TlsConnectionMetadata> for Connection

fn from(metadata: TlsConnectionMetadata) -> Self

Creates a Connection using a TLS transport from TlsConnectionMetadata.