Struct rust_engineio::asynchronous::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Implementations

impl ClientBuilder

pub fn new(url: Url) -> Self

pub fn tls_config(self, tls_config: TlsConnector) -> Self

Specify transport’s tls config

pub fn headers(self, headers: HeaderMap) -> Self

Specify transport’s HTTP headers

pub fn on_close<T>(self, callback: T) -> Selfwhere
    T: 'static + Send + Sync + Fn(()) -> BoxFuture<'static, ()>,

Registers the on_close callback.

pub fn on_data<T>(self, callback: T) -> Selfwhere
    T: 'static + Send + Sync + Fn(Bytes) -> BoxFuture<'static, ()>,

Registers the on_data callback.

pub fn on_error<T>(self, callback: T) -> Selfwhere
    T: 'static + Send + Sync + Fn(String) -> BoxFuture<'static, ()>,

Registers the on_error callback.

pub fn on_open<T>(self, callback: T) -> Selfwhere
    T: 'static + Send + Sync + Fn(()) -> BoxFuture<'static, ()>,

Registers the on_open callback.

pub fn on_packet<T>(self, callback: T) -> Selfwhere
    T: 'static + Send + Sync + Fn(Packet) -> BoxFuture<'static, ()>,

Registers the on_packet callback.

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

Build websocket if allowed, if not fall back to polling

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

Build socket with polling transport

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

Build socket with a polling transport then upgrade to websocket transport

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

Build socket with only a websocket transport

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

Build websocket if allowed, if not allowed or errored fall back to polling. WARNING: websocket errors suppressed, no indication of websocket success or failure.

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.