Struct WebSocketFrameEvent 

pub struct WebSocketFrameEvent {
    pub correlation_id: String,
    pub opcode: String,
    pub data: Vec<u8>,
    pub client_to_server: bool,
    pub frame_index: u64,
    pub fin: bool,
    pub route_id: Option<String>,
    pub client_ip: String,
}

WebSocket frame event - sent for each frame when inspection is enabled

Fields

correlation_id: String

Same as the original HTTP upgrade request

opcode: String

“text”, “binary”, “ping”, “pong”, “close”, “continuation”

data: Vec<u8>

Frame payload (raw bytes for gRPC)

client_to_server: bool

Direction: true = client->server, false = server->client

frame_index: u64

0-based frame index for this connection (per direction)

fin: bool

FIN bit - true if final frame of message

route_id: Option<String>

client_ip: String

Implementations

impl WebSocketFrameEvent

pub fn route_id(&self) -> &str

Returns the value of route_id, or the default value if route_id is unset.

Trait Implementations

impl Clone for WebSocketFrameEvent

fn clone(&self) -> WebSocketFrameEvent

Returns a duplicate 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 Default for WebSocketFrameEvent

fn default() -> Self

Returns the “default value” for a type.

impl Message for WebSocketFrameEvent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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 StructuralPartialEq for WebSocketFrameEvent