Struct Builder 

pub struct Builder { /* private fields */ }

Builder to configure a Client

Implementations

impl Builder

pub fn new(uri: Uri) -> Result<Self, Error>

Returns a new instance with defaults set.

pub fn ws_config(self, ws_config: WebSocketConfig) -> Self

Configure the WebSocketConfig

pub fn add_header(self, key: String, value: String) -> Self

Add headers to the client connection request.

pub fn add_sub_protocol(self, key: String, value: String) -> Self

Add a sub-protocol header to the WebSocket connection.

pub fn auth_token(self, token: &str) -> Self

Set the authentication token to pass to the server.

pub fn tls_config(self, tls_config: Arc<ClientConfig>) -> Self

Configure the WebSocketConfig

pub fn heartbeat(self, heartbeat: Duration) -> Self

Set the heart-bit interval duration.

pub async fn connect(self) -> Result<Client, Error>

Returns a configured client.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.