Enum WebsocketFrameEvent

pub enum WebsocketFrameEvent {
    Start {
        frame_info: FrameInfo,
        original_opcode: Opcode,
    },
    PayloadChunk {
        original_opcode: Opcode,
    },
    End {
        frame_info: FrameInfo,
        original_opcode: Opcode,
    },
}

Information that WebsocketFrameDecoder gives in return to bytes being fed to it.

Variants

Start

Indicates a frame is started.

original_opcode is the same as frame_info.opcode, except for Opcode::Continuation frames, for which it should refer to initial frame in sequence (i.e. Opcode::Text or Opcode::Binary)

Fields

frame_info: FrameInfo

original_opcode: Opcode

PayloadChunk

Bytes which were supplied to WebsocketFrameDecoder::add_data are payload bytes, transformed for usage as a part of payload.

You should use WebsocketFrameDecoderAddDataResult::consumed_bytes to get actual buffer to be handled as content coming from the WebSocket.

Mind the original_opcode to avoid mixing content of control frames and data frames.

Fields

original_opcode: Opcode

End

Indicates that all PayloadChunks for the given frame are delivered and the frame is ended.

You can watch for frame_info.fin together with checking original_opcode to know wnen WebSocket message (not just a frame) ends.

frame_info is the same as in WebsocketFrameEvent::Start’s frame_info.

Fields

frame_info: FrameInfo

original_opcode: Opcode

Trait Implementations

impl Clone for WebsocketFrameEvent

fn clone(&self) -> WebsocketFrameEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebsocketFrameEvent

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

Formats the value using the given formatter.

impl PartialEq for WebsocketFrameEvent

fn eq(&self, other: &WebsocketFrameEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WebsocketFrameEvent

impl StructuralPartialEq for WebsocketFrameEvent