Struct Target

pub struct Target { /* private fields */ }

A target describes the TCP or Unix socket that a client will connect to, along with any optional TLS parameters.

Implementations

impl Target

pub fn new(name: TargetName) -> Self

pub fn new_tls(name: TargetName, params: TlsParameters) -> Self

pub fn new_starttls(name: TargetName, params: TlsParameters) -> Self

pub fn new_resolved(target: ResolvedTarget) -> Self

pub fn new_resolved_tls(target: ResolvedTarget, params: TlsParameters) -> Self

pub fn new_resolved_starttls( target: ResolvedTarget, params: TlsParameters, ) -> Self

pub fn new_unix_path(path: impl AsRef<Path>) -> Result<Self, Error>

Create a new target for a Unix socket.

pub fn new_unix_domain(domain: impl AsRef<[u8]>) -> Result<Self, Error>

Create a new target for a Unix socket.

pub fn new_tcp(host: impl TcpResolve) -> Self

Create a new target for a TCP socket.

pub fn new_tcp_tls(host: impl TcpResolve, params: TlsParameters) -> Self

Create a new target for a TCP socket with TLS.

pub fn new_tcp_starttls(host: impl TcpResolve, params: TlsParameters) -> Self

Create a new target for a TCP socket with STARTTLS.

pub fn try_set_tls( &mut self, params: TlsParameters, ) -> Option<Option<Arc<TlsParameters>>>

pub fn try_remove_tls(&mut self) -> Option<Arc<TlsParameters>>

pub fn is_tcp(&self) -> bool

Check if the target is a TCP connection.

pub fn port(&self) -> Option<u16>

Get the port of the target. If the target type does not include a port, this will return None.

pub fn try_set_port(&mut self, port: u16) -> Option<u16>

Set the port of the target. If the target type does not include a port, this will return None. Otherwise, it will return the old port.

pub fn path(&self) -> Option<&Path>

Get the path of the target. If the target type does not include a path, this will return None.

pub fn host(&self) -> Option<Cow<'_, str>>

Get the host of the target. For resolved IP addresses, this is the string representation of the IP address. For unresolved hostnames, this is the hostname. If the target type does not include a host, this will return None.

pub fn name(&self) -> Option<ServerName<'_>>

Get the name of the target. For resolved IP addresses, this is the string representation of the IP address. For unresolved hostnames, this is the hostname.

pub fn tcp(&self) -> Option<(Cow<'_, str>, u16)>

Get the host and port of the target. If the target type does not include a host or port, this will return None.

Trait Implementations

impl Clone for Target

fn clone(&self) -> Target

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Target

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

Formats the value using the given formatter.