Struct ws_tool::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

helper builder to construct websocket client

Implementations

impl ClientBuilder

pub async fn async_connect<C, F>(&self, check_fn: F) -> Result<C, WsError>where
    F: Fn(String, Response<()>, BytesMut, WsAsyncStream<TcpStream>) -> Result<C, WsError>,

async version of connect

perform protocol handshake & check server response

impl ClientBuilder

pub fn new<S: ToString>(uri: S) -> 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

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