Struct ConnectionOptions 

pub struct ConnectionOptions {
    pub host: String,
    pub port: i64,
    pub tls: bool,
    pub allow_insecure_tls: bool,
    pub pat_token: Option<String>,
}

Explicit connection configuration. Connection settings used to build the websocket request.

Example

use lirays::ConnectionOptions;

let opts = ConnectionOptions::new("127.0.0.1", 8245, false, None);
assert_eq!(opts.ws_url().unwrap(), "ws://127.0.0.1:8245/ws");

Fields

host: String

Server hostname or IP address.

port: i64

Server TCP port.

tls: bool

Enables wss:// when true, otherwise uses ws://.

allow_insecure_tls: bool

Skips certificate validation when true.

This is intended only for local development with self-signed certs.

pat_token: Option<String>

Optional PAT token sent as Authorization: Bearer <token>.

Implementations

impl ConnectionOptions

pub fn new( host: impl Into<String>, port: i64, tls: bool, pat_token: Option<String>, ) -> Self

Creates a new set of connection options.

pub fn with_insecure_tls(self, allow_insecure_tls: bool) -> Self

Enables or disables insecure TLS certificate verification bypass.

pub fn ws_url(&self) -> Result<String, ClientError>

Returns the final websocket URL in the form ws(s)://host:port/ws.

Trait Implementations

impl Clone for ConnectionOptions

fn clone(&self) -> ConnectionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionOptions

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

Formats the value using the given formatter.