Struct awc::ws::WebsocketsRequest

pub struct WebsocketsRequest { /* fields omitted */ }

WebSocket connection

Implementations

impl WebsocketsRequest

pub fn address(self, addr: SocketAddr) -> Self

Set socket address of the server.

This address is used for connection. If address is not provided url’s host name get resolved.

pub fn protocols<U, V>(self, protos: U) -> Self where
    U: IntoIterator<Item = V>,
    V: AsRef<str>, 

Set supported websocket protocols

pub fn cookie(self, cookie: Cookie<'_>) -> Self

Set a cookie

pub fn origin<V, E>(self, origin: V) -> Self where
    HeaderValue: TryFrom<V, Error = E>,
    HttpError: From<E>, 

Set request Origin

pub fn max_frame_size(self, size: usize) -> Self

Set max frame size

By default max size is set to 64kb

pub fn server_mode(self) -> Self

Disable payload masking. By default ws client masks frame payload.

pub fn header<K, V>(self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    V: IntoHeaderValue, 

Append a header.

Header gets appended to existing header. To override header use set_header() method.

pub fn set_header<K, V>(self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    V: IntoHeaderValue, 

Insert a header, replaces existing header.

pub fn set_header_if_none<K, V>(self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    V: IntoHeaderValue, 

Insert a header only if it is not yet set.

pub fn basic_auth<U>(self, username: U, password: Option<&str>) -> Self where
    U: Display, 

Set HTTP basic authorization header

pub fn bearer_auth<T>(self, token: T) -> Self where
    T: Display, 

Set HTTP bearer authentication header

pub async fn connect(
    self
) -> Result<(ClientResponse, Framed<BoxedSocket, Codec>), WsClientError>

Complete request construction and connect to a websockets server.

Trait Implementations

impl Debug for WebsocketsRequest

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

Formats the value using the given formatter.