Struct WsClient 

pub struct WsClient<F, T> { /* private fields */ }

WebSocket client builder

Implementations

impl WsClient<Base, ()>

pub fn build<U>(uri: U) -> WsClientBuilder<Base, Connector<Uri>>

where Uri: TryFrom<U>, <Uri as TryFrom<U>>::Error: Into<HttpError>,

Create new websocket client builder

pub fn with_connector<F, T, U>(uri: U, connector: T) -> WsClientBuilder<F, T>

where Uri: TryFrom<U>, <Uri as TryFrom<U>>::Error: Into<HttpError>, F: Filter, T: Service<Connect<Uri>, Response = Io<F>, Error = ConnectError>,

Create new websocket client builder

impl<F, T> WsClient<F, T>

pub fn set_header<K, V>(&self, key: K, value: V) -> Result<(), HttpError>

where HeaderName: TryFrom<K>, HeaderValue: TryFrom<V>, <HeaderName as TryFrom<K>>::Error: Into<HttpError>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Insert a header, replaces existing header.

pub fn set_basic_auth<U>( &self, username: U, password: Option<&str>, ) -> Result<(), HttpError>

where U: Display,

Set HTTP basic authorization header

pub fn set_bearer_auth<U>(&self, token: U) -> Result<(), HttpError>

where U: Display,

Set HTTP bearer authentication header

impl<F, T> WsClient<F, T>

where F: Filter, T: Service<Connect<Uri>, Response = Io<F>, Error = ConnectError>,

pub async fn connect(&self) -> Result<WsConnection<F>, WsClientError>

Complete request construction and connect to a websockets server.

Trait Implementations

impl<F, T> Debug for WsClient<F, T>

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

Formats the value using the given formatter.