Struct ws_tool::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

helper builder to construct websocket client

Implementations

impl ClientBuilder

pub fn connect<C, F>(&self, uri: Uri, check_fn: F) -> Result<C, WsError>

where F: FnMut(String, Response<()>, TcpStream) -> Result<C, WsError>,

perform protocol handshake & check server response

pub fn rustls_connect<C, F>(&self, uri: Uri, check_fn: F) -> Result<C, WsError>

where F: FnMut(String, Response<()>, StreamOwned<ClientConnection, TcpStream>) -> Result<C, WsError>,

perform protocol handshake via ssl with default certs & check server response

pub fn with_stream<C, F, S>( &self, uri: Uri, stream: S, check_fn: F ) -> Result<C, WsError>

where S: Read + Write, F: FnMut(String, Response<()>, S) -> Result<C, WsError>,

Low level api

perform protocol handshake & check server response

impl ClientBuilder

pub fn new() -> Self

create builder with websocket url

pub fn protocol(self, protocol: String) -> Self

add protocols

pub fn protocols(self, protocols: Vec<String>) -> Self

set extension in handshake http header

NOTE it will clear protocols set by protocol method

pub fn extension(self, extension: String) -> Self

add protocols

pub fn extensions(self, extensions: Vec<String>) -> Self

set extension in handshake http header

NOTE it will clear protocols set by protocol method

pub fn version(self, version: u8) -> Self

set websocket version, default 13

pub fn header<K: ToString, V: ToString>(self, name: K, value: V) -> Self

add initial request header

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

set initial request headers

NOTE it will clear header set by previous header method

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.