Struct ClientConfig 

pub struct ClientConfig {
    pub url: String,
    pub token: Sensitive<String>,
    pub name: String,
    pub version: String,
    pub data: Option<Vec<u8>>,
    pub headers: FastMap<String, String>,
    pub min_reconnect_delay: Duration,
    pub max_reconnect_delay: Duration,
    pub(super) get_token: Option<Arc<dyn Fn() -> Pin<Box<dyn Future<Output = Result<Sensitive<String>, Error>> + Send + 'static>> + Send + Sync>>,
}

Connection identity, authentication, and reconnect settings for a crate::Client.

Fields

url: String

token: Sensitive<String>

name: String

version: String

data: Option<Vec<u8>>

headers: FastMap<String, String>

min_reconnect_delay: Duration

max_reconnect_delay: Duration

get_token: Option<Arc<dyn Fn() -> Pin<Box<dyn Future<Output = Result<Sensitive<String>, Error>> + Send + 'static>> + Send + Sync>>

Implementations

impl ClientConfig

pub fn new(url: impl Into<String>, token: Sensitive<String>) -> Self

Creates connection settings for url authenticated with token.

pub fn name(self, name: impl Into<String>) -> Self

Sets the client implementation name sent during the handshake.

pub fn version(self, version: impl Into<String>) -> Self

Sets the client implementation version sent during the handshake.

pub fn data(self, data: Vec<u8>) -> Self

Sets application data sent during the handshake.

pub fn headers(self, headers: FastMap<String, String>) -> Self

Replaces all additional handshake headers.

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds or replaces one additional handshake header.

pub fn get_token<F, Fut>(self, f: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Sensitive<String>, Error>> + Send + 'static,

Installs the callback used to replace an expired connection token.

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.