Struct WebSocketRequestBuilder

pub struct WebSocketRequestBuilder { /* private fields */ }

Wrapper for RequestBuilder that performs the websocket handshake when sent.

Implementations

impl WebSocketRequestBuilder

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

Sets the websocket subprotocols to request.

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

Add a set of Headers to the existing ones on this Request.

The headers will be merged in to any already set.

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

Sets the websocket max_frame_size configuration.

pub fn write_buffer_size(self, write_buffer_size: usize) -> Self

Sets the websocket write_buffer_size configuration.

pub fn max_write_buffer_size(self, max_write_buffer_size: usize) -> Self

Sets the websocket max_write_buffer_size configuration.

pub fn max_message_size(self, max_message_size: usize) -> Self

Sets the websocket max_message_size configuration.

pub fn accept_unmasked_frames(self, accept_unmasked_frames: bool) -> Self

Sets the websocket accept_unmasked_frames configuration.

pub async fn send(self) -> Result<WebSocketResponse, Error>

Sends the request and returns and WebSocketResponse.

Trait Implementations

impl Debug for WebSocketRequestBuilder

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

Formats the value using the given formatter.