This reference describes unreleased code on main; no release documents it yet.

rlmesh::ext::ConnectAddress

enumPreviewuse rlmesh::ext::ConnectAddress;[source]

A client-side address for connecting to a running server.

enum ConnectAddress

Build one with ConnectAddress::parse, or pass a &str directly to the clients (e.g. crate::RemoteEnvOptions::address).

Variants

Tcp(String)

A TCP endpoint, e.g. tcp://host:port.

Unix(std::path::PathBuf)

A Unix-domain socket path (Unix only).

associated function[source]

fn parse(value: impl AsRef<str>) -> Result<Self>

Parse a connect target such as host:port, tcp://host:port, or unix:///path/to.sock.

Returns Error::InvalidArgument if value is not a recognized address (including a unix:// path on Windows, where Unix sockets are unsupported).

fn as_str(&self) -> String

The address rendered as a connect string (tcp://... or unix://...).