Struct WebSocketReadResponse 

pub struct WebSocketReadResponse {
    pub messages: Vec<BufferedMessage>,
    pub latest_index: Option<u64>,
    pub oldest_index: Option<u64>,
}

Response for WebSocket read operations.

This struct captures the read result with messages and buffer state information.

Gap Detection

Consumers can detect gaps by comparing message indices. Each BufferedMessage contains an index field that increases monotonically. If there’s a gap between indices, some messages were evicted from the buffer.

Convenience Methods

For common access patterns, use the convenience methods instead of accessing fields directly:

// Instead of:
let data = response.messages.first().unwrap().content.as_data().unwrap();

// Use:
let data = response.first_data().unwrap();

Fields

messages: Vec<BufferedMessage>

All requested messages (based on read mode).

latest_index: Option<u64>

Current highest index in buffer (for tracking).

oldest_index: Option<u64>

Current lowest index in buffer (helpful for gap detection).

Implementations

impl WebSocketReadResponse

pub fn has_messages(&self) -> bool

Returns true if there are any messages in the response.

pub fn message_count(&self) -> usize

Returns the number of messages in the response.

pub fn first_message(&self) -> Option<&BufferedMessage>

Get the first (oldest) message, if any.

pub fn latest_message(&self) -> Option<&BufferedMessage>

Get the last (most recent) message, if any.

pub fn first_data(&self) -> Option<&[u8]>

Get the data from the first message (convenience for common pattern).

Returns None if there are no messages or if the first message is a system message.

pub fn latest_data(&self) -> Option<&[u8]>

Get the data from the latest message (convenience for common pattern).

Returns None if there are no messages or if the latest message is a system message.

pub fn data_messages(&self) -> impl Iterator<Item = &BufferedMessage>

Iterate over only the data messages (filtering out system messages).

pub fn iter_data(&self) -> impl Iterator<Item = &[u8]>

Iterate over only the data bytes (convenience for processing).

This filters out system messages and returns only the raw data bytes.

pub fn data_message_count(&self) -> usize

Returns the number of data messages (excluding system messages).

pub fn has_system_messages(&self) -> bool

Returns true if any message is a system message (like OversizedWarning).

Trait Implementations

impl BorshDeserialize for WebSocketReadResponse

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for WebSocketReadResponse

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for WebSocketReadResponse

fn clone(&self) -> WebSocketReadResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketReadResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSocketReadResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WebSocketReadResponse

impl PartialEq for WebSocketReadResponse

fn eq(&self, other: &WebSocketReadResponse) -> 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 Serialize for WebSocketReadResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebSocketReadResponse