Struct ServerAddress 

pub struct ServerAddress { /* private fields */ }

The address of a Lightstreamer server, parsed and checked at construction.

A Lightstreamer server is reached at a host and port, and this crate speaks to it over a WebSocket. Both spellings are accepted, because deployments publish their endpoint either way:

You write	Meaning
wss://push.example.com	WebSocket over TLS
https://push.example.com	the same thing
ws://localhost:8080	WebSocket, no TLS
http://localhost:8080	the same thing
wss://[::1]:8080	an IPv6 literal, which must be bracketed

What an address may and may not contain

The address is a scheme, a host and an optional port, optionally followed by a base path. Everything else is refused here rather than somewhere further down, where the failure would be a connection error instead of a configuration one:

Rejected	Why
wss://user:secret@host	userinfo is a credential, and a credential in an address ends up in every log line that mentions the address
wss://host?a=b, wss://host#f	TLCP defines no query or fragment on the endpoint; carrying one would silently change what is requested
wss://host/a/../b	a .. segment makes the composed endpoint depend on path normalisation this crate does not perform
wss://host:0, wss://host:99999	not a port
wss:// host	not a host

The endpoint path

The TLCP endpoint path is not part of the address: this crate appends the /lightstreamer path the protocol fixes [docs/spec/01-foundations.md §6.2.1]. An address that already ends in /lightstreamer is accepted and not doubled. A base path is accepted too, for a server published behind a reverse proxy, and the fixed path is appended to it — https://example.com/push reaches /push/lightstreamer.

Canonical form

ServerAddress::as_str returns the address with the scheme lowercased and any trailing / removed; the host is left in the caller’s own spelling. Because userinfo is refused, the canonical form is also the redacted form: it is safe to log.

Examples

use lightstreamer_rs::ServerAddress;

let address = ServerAddress::try_new("https://push.lightstreamer.com")?;
assert!(address.is_secure());

A missing scheme is rejected rather than guessed at, because guessing https for an address the caller meant as plain http would silently change the security properties of the connection:

use lightstreamer_rs::ServerAddress;

assert!(ServerAddress::try_new("push.lightstreamer.com").is_err());

Implementations

impl ServerAddress

pub fn try_new(address: impl Into<String>) -> Result<Self, ConfigError>

Parses and checks a server address.

Errors

• ConfigError::EmptyServerAddress if the text is empty or only whitespace.
• ConfigError::MissingScheme if there is no ://.
• ConfigError::UnsupportedScheme if the scheme is not one of ws, wss, http or https.
• ConfigError::MissingHost if nothing follows the scheme.
• ConfigError::AddressHasUserinfo if the authority carries a user:password@ prefix.
• ConfigError::InvalidHost if the host is empty or contains whitespace, a control character, or an unbracketed :.
• ConfigError::InvalidPort if the port is not a number in 1..=65535.
• ConfigError::InvalidAddressPath if a query, a fragment, a .. segment, whitespace or a control character follows the authority.

Examples

use lightstreamer_rs::{ConfigError, ServerAddress};

assert!(matches!(
    ServerAddress::try_new("ftp://push.example.com"),
    Err(ConfigError::UnsupportedScheme { .. })
));

// A credential in an address would reach every log line that mentions it.
assert!(matches!(
    ServerAddress::try_new("wss://alice:hunter2@push.example.com"),
    Err(ConfigError::AddressHasUserinfo)
));

pub fn as_str(&self) -> &str

The address in canonical form: scheme lowercased, no trailing /, and nothing in it that needs redacting.

pub const fn is_secure(&self) -> bool

Whether the connection will be encrypted.

True for the wss and https schemes, false for ws and http.

Trait Implementations

impl Clone for ServerAddress

fn clone(&self) -> ServerAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerAddress

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

Formats the value using the given formatter.

impl Display for ServerAddress

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

Formats the value using the given formatter.

impl Eq for ServerAddress

impl Hash for ServerAddress

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

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 Ord for ServerAddress

fn cmp(&self, other: &ServerAddress) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ServerAddress

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ServerAddress

fn partial_cmp(&self, other: &ServerAddress) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ServerAddress