Struct actix_ws::MessageStream

pub struct MessageStream { /* private fields */ }

Stream of messages from a WebSocket client.

Implementations

impl MessageStream

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

Sets the maximum permitted size for received WebSocket frames, in bytes.

By default, up to 64KiB is allowed.

Any received frames larger than the permitted value will return Err(ProtocolError::Overflow) instead.

// increase permitted frame size from 64KB to 1MB
let stream = stream.max_frame_size(1024 * 1024);

pub fn aggregate_continuations(self) -> AggregatedMessageStream

Returns a stream wrapper that collects continuation frames into their equivalent aggregated forms, i.e., binary or text.

By default, continuations will be aggregated up to 1MiB in size (customizable with AggregatedMessageStream::max_continuation_size()). The stream implementation returns an error if this size is exceeded.

pub async fn recv(&mut self) -> Option<Result<Message, ProtocolError>>

Waits for the next item from the message stream

This is a convenience for calling the Stream implementation.

while let Some(Ok(msg)) = stream.recv().await {
    // handle message
}

Trait Implementations

impl Stream for MessageStream

type Item = Result<Message, ProtocolError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.