Struct WebSocketEndpoint 

pub struct WebSocketEndpoint { /* private fields */ }

A ws:// or wss:// URL naming a Citadel server.

Parsing refuses anything a client could not dial as a WebSocket, and URLs carrying credentials (wss://user:pass@host/): those would be sent to the edge as HTTP basic auth, which is never what a Citadel client means.

Implementations

impl WebSocketEndpoint

pub fn parse(input: &str) -> Result<WebSocketEndpoint, NetworkError>

Parses and validates a WebSocket URL.

pub fn is_secure(&self) -> bool

True for wss:// (TLS to the edge).

pub fn host(&self) -> String

The host to dial and to present as TLS SNI, without IPv6 brackets.

pub fn port(&self) -> u16

The explicit port, or the scheme’s default (80 for ws, 443 for wss).

pub fn as_str(&self) -> &str

The URL as dialled.

pub async fn resolve(&self) -> Result<SocketAddr, Error>

Resolves the host to one socket address, for the protocol’s per-connection bookkeeping. The dial itself resolves the hostname again, so a DNS change is honoured on reconnect.

Trait Implementations

impl Clone for WebSocketEndpoint

fn clone(&self) -> WebSocketEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketEndpoint

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

Formats the value using the given formatter.

impl Display for WebSocketEndpoint

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

Formats the value using the given formatter.

impl Eq for WebSocketEndpoint

impl FromStr for WebSocketEndpoint

type Err = NetworkError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<WebSocketEndpoint, <WebSocketEndpoint as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for WebSocketEndpoint

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WebSocketEndpoint

fn eq(&self, other: &WebSocketEndpoint) -> 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 StructuralPartialEq for WebSocketEndpoint