Enum ConnectionEndpoint 

pub enum ConnectionEndpoint {
    Tcp {
        host: String,
        port: u16,
    },
    DomainSocket {
        directory: PathBuf,
        name: String,
    },
}

Represents a connection endpoint for Hyper database.

Supports different transport mechanisms:

• TCP: tab.tcp://host:port
• Unix Domain Socket: tab.domain://<directory>/domain/<name> (Unix only)
• Windows Named Pipe: tab.pipe://<host>/pipe/<name> (Windows only, future)

Variants

Tcp

TCP endpoint: tab.tcp://host:port

Fields

host: String

Hostname or IP address

port: u16

Port number (0 for auto-assign)

DomainSocket

Unix Domain Socket: tab.domain://<directory>/domain/<name>

Fields

directory: PathBuf

Directory containing the socket file

name: String

Socket name (e.g., .s.PGSQL.12345)

Implementations

impl ConnectionEndpoint

pub fn tcp(host: impl Into<String>, port: u16) -> Self

Creates a new TCP endpoint.

pub fn domain_socket( directory: impl Into<PathBuf>, name: impl Into<String>, ) -> Self

Creates a new Unix Domain Socket endpoint.

pub fn parse(descriptor: &str) -> Result<Self>

Parses a connection descriptor string.

Supported formats:

• tab.tcp://host:port or host:port → TCP
• tab.domain://<dir>/domain/<name> → Unix Domain Socket
• tab.pipe://<host>/pipe/<name> → Named Pipe (future)

Errors

Returns Error (connection) when:

• The descriptor has the tab.domain:// prefix but is missing the /domain/ separator, has an empty socket name, or is used on a non-Unix platform.
• The descriptor has the tab.pipe:// prefix but malformed /pipe/ segment, empty name, or is used on a non-Windows platform.
• The TCP descriptor cannot be parsed into a host:port pair, or the port is not a valid u16.

pub fn to_descriptor(&self) -> String

Returns the connection descriptor string format.

This is the format used by Hyper for --listen-connection and --callback-connection.

pub fn socket_path(&self) -> Option<PathBuf>

Returns the socket file path for Unix Domain Sockets.

pub fn is_tcp(&self) -> bool

Returns true if this is a TCP endpoint.

pub fn is_domain_socket(&self) -> bool

Returns true if this is a Unix Domain Socket endpoint.

pub fn tcp_addr(&self) -> Option<(&str, u16)>

Returns the host and port for TCP endpoints.

Trait Implementations

impl Clone for ConnectionEndpoint

fn clone(&self) -> ConnectionEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionEndpoint

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

Formats the value using the given formatter.

impl Display for ConnectionEndpoint

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

Formats the value using the given formatter.

impl PartialEq for ConnectionEndpoint

fn eq(&self, other: &ConnectionEndpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConnectionEndpoint

impl StructuralPartialEq for ConnectionEndpoint