Struct WebSocketReadResult

pub struct WebSocketReadResult {
    pub len_from: usize,
    pub len_to: usize,
    pub end_of_message: bool,
    pub close_status: Option<WebSocketCloseStatusCode>,
    pub message_type: WebSocketReceiveMessageType,
}

The metadata result of a read function call of a websocket

Fields

len_from: usize

Number of bytes read from the from buffer

len_to: usize

Number of bytes written to the to buffer

end_of_message: bool

End of message flag is true if the to buffer contains an entire websocket frame payload otherwise false if the user must continue calling the read function to get the rest of the payload

close_status: Option<WebSocketCloseStatusCode>

Close status code (as per the websocket spec) if the message type is CloseMustReply or CloseCompleted. If a close status is specified then a UTF8 encoded string could also appear in the frame payload giving more detailed information about why the websocket was closed.

message_type: WebSocketReceiveMessageType

The websocket frame type

Trait Implementations

impl Debug for WebSocketReadResult

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

Formats the value using the given formatter.