Struct ClientConfig 

pub struct ClientConfig { /* private fields */ }

Everything needed to open a session, checked and ready to use.

Build one with ClientConfig::builder; the fields are private so a configuration that failed a check cannot exist. Hand it to Client::connect.

Examples

use std::time::Duration;
use lightstreamer_rs::{
    AdapterSet, ClientConfig, ConnectionOptions, Credentials, ServerAddress,
};

let config = ClientConfig::builder(ServerAddress::try_new("wss://push.example.com")?)
    .with_adapter_set(AdapterSet::try_new("MY_ADAPTERS")?)
    .with_credentials(Credentials::new("alice", "hunter2"))
    .with_options(ConnectionOptions::default().with_open_timeout(Duration::from_secs(5)))
    .build()?;

assert_eq!(config.adapter_set().map(AdapterSet::as_str), Some("MY_ADAPTERS"));

Implementations

impl ClientConfig

pub fn builder(address: ServerAddress) -> ClientConfigBuilder

Starts building a configuration for a server.

The address is the only value with no sensible default, so it is taken here rather than left to be forgotten.

pub const fn address(&self) -> &ServerAddress

The server this configuration points at.

pub const fn adapter_set(&self) -> Option<&AdapterSet>

The Adapter Set that will serve the session, or None to let the server use its DEFAULT.

pub const fn credentials(&self) -> &Credentials

The credentials the session will be created with.

pub const fn transport(&self) -> Transport

The transport that will carry the session.

pub const fn options(&self) -> &ConnectionOptions

The timeouts, limits and reconnection policy.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Eq for ClientConfig

impl PartialEq for ClientConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientConfig