Struct TargetName

pub struct TargetName { /* private fields */ }

A target name describes the TCP or Unix socket that a client will connect to.

Implementations

impl TargetName

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 to_addrs_sync(&self) -> Result<Vec<ResolvedTarget>, Error>

Resolves the target addresses for a given host.

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 Debug for TargetName

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

Formats the value using the given formatter.