Struct ClientFrame 

pub struct ClientFrame { /* private fields */ }

A length-prefixed external client frame.

The wire shape is:

u32 body_len_be | u16 protocol_version_be | payload bytes

body_len includes the version field and the payload. Unknown future protocol versions are rejected loud, matching RULES R-3/R-4.

Implementations

impl ClientFrame

pub fn new(payload: impl Into<Bytes>) -> Self

Build a v1 frame.

pub fn from_message( message: &ClientWireMessage, ) -> Result<Self, ClientProtocolError>

Encode a typed wire message as this frame payload.

pub fn with_version(protocol_version: u16, payload: impl Into<Bytes>) -> Self

Build a frame with an explicit protocol version for compatibility tests.

pub fn protocol_version(&self) -> u16

Return the frame protocol version.

pub fn payload(&self) -> &Bytes

Return the opaque payload bytes.

pub fn encode(&self) -> Result<Bytes, ClientProtocolError>

Encode the frame with a big-endian length prefix.

pub fn decode_message(&self) -> Result<ClientWireMessage, ClientProtocolError>

Decode the frame payload as a typed wire message.

pub fn decode( bytes: &[u8], max_frame_bytes: usize, ) -> Result<Self, ClientProtocolError>

Decode and validate a frame.

Trait Implementations

impl Clone for ClientFrame

fn clone(&self) -> ClientFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientFrame

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

Formats the value using the given formatter.

impl Eq for ClientFrame

impl PartialEq for ClientFrame

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