Struct ConnectionBuilder

pub struct ConnectionBuilder { /* private fields */ }

A builder for creating a new endpoint.

Implementations

impl ConnectionBuilder

pub fn new( remote_name: &str, remote_addr: SocketAddr, app_name: &str, app_version: &str, protocol_version: &str, status: Status, cert: &[u8], key: &[u8], ) -> Result<Self>

Creates a new builder with the remote address, certificate, and key.

Errors

Returns an error if the certificate or key is invalid.

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

Sets the certificate for the connection.

Errors

Returns an error if the certificate is invalid.

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

Sets the private key for the connection.

Errors

Returns an error if the key is invalid.

pub fn root_certs<I>(&mut self, certs: I) -> Result<&mut Self>

where I: IntoIterator, I::Item: AsRef<[u8]>,

Sets the root certificates for the connection.

Errors

Returns an error if any of the certificates are invalid.

pub fn add_root_certs(&mut self, rd: &mut dyn BufRead) -> Result<&mut Self>

Adds root certificates to the certificate store.

It reads certificates from the given reader, filtering out any PEM sections.

Errors

Returns an error if the reader is invalid or the certificates are invalid.

pub fn local_addr(&mut self, addr: IpAddr) -> &mut Self

Sets the local address to bind to.

This is only necessary if the unspecified address (:: for IPv6 and 0.0.0.0 for IPv4) is not desired.

pub async fn connect(&self) -> Result<Connection>

Connects to the server and performs a handshake.

Errors

Returns an error if the connection fails or the server requires a different protocol version.

Trait Implementations

impl Debug for ConnectionBuilder

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

Formats the value using the given formatter.