Struct warp::filters::ws::Ws

pub struct Ws { /* private fields */ }

Extracted by the ws filter, and used to finish an upgrade.

Implementations

impl Ws

pub fn on_upgrade<F, U>(self, func: F) -> impl Reply

where F: FnOnce(WebSocket) -> U + Send + 'static, U: Future<Output = ()> + Send + 'static,

Finish the upgrade, passing a function to handle the WebSocket.

The passed function must return a Future.

pub fn max_send_queue(self, _max: usize) -> Self

👎Deprecated: use max_write_buffer_size instead

Does nothing.

Deprecated

Use max_write_buffer_size() instead.

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

The max size of the write buffer, in bytes.

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

Set the maximum message size (defaults to 64 megabytes)

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

Set the maximum frame size (defaults to 16 megabytes)

Trait Implementations

impl Debug for Ws

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

Formats the value using the given formatter.