Struct WebSocketConnection 

pub struct WebSocketConnection { /* private fields */ }

Represents the extractor for establishing WebSockets connections

Implementations

impl WebSocketConnection

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

Sets the read buffer capacity.

Default: 128KiB

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

Sets the target minimum size of the write buffer to reach before writing the data to the underlying stream.

Default: 128 KiB.

If set to 0 each message will be eagerly written to the underlying stream. It is often more optimal to allow them to buffer a little, hence the default value.

Note: flush will always fully write the buffer regardless.

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

Sets the max size of the write buffer in bytes. Setting this can provide backpressure in the case the write buffer is filling up due to write errors.

Default: not set/unlimited

Note: The write buffer only builds up past write_buffer_size when writes to the underlying stream are failing. So the write buffer cannot fill up if you are not observing write errors even if not flushing.

Note: Should always be at least write_buffer_size + 1 message and probably a little more depending on error handling strategy.

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

Sets the maximum message size

Default: 64 MiB

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

Sets the maximum frame size

Default: 16 MiB

pub fn with_accept_unmasked_frames(self, accept: bool) -> Self

Sets/unsets a web-server to accept unmasked frames

Default: false

pub fn with_protocols<const N: usize>(self, known: [&'static str; N]) -> Self

Sets the protocols known by the server.

Default: empty list

pub fn on<F, Fut>(self, func: F) -> HttpResult

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

Upgrades a connection and call a mapped handler with the stream.

Trait Implementations

impl Debug for WebSocketConnection

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

Formats the value using the given formatter.

impl TryFrom<&Parts> for WebSocketConnection

type Error = Error

The type returned in the event of a conversion error.

fn try_from(parts: &Parts) -> Result<Self, Self::Error>

Performs the conversion.