Struct Frame 

pub struct Frame {
    pub stream_id: u32,
    pub sequence: u32,
    pub flags: FrameFlags,
    pub payload: Bytes,
}

Protocol frame structure

Fields

stream_id: u32

Stream identifier

sequence: u32

Sequence number

flags: FrameFlags

Frame flags

payload: Bytes

Frame payload

Implementations

impl Frame

pub fn new( stream_id: u32, sequence: u32, flags: FrameFlags, payload: Bytes, ) -> Self

Create a new frame

pub fn data(stream_id: u32, sequence: u32, payload: Bytes) -> Self

Create a data frame

pub fn end_stream(stream_id: u32, sequence: u32) -> Self

Create an end-of-stream frame

pub fn error(stream_id: u32, sequence: u32, payload: Bytes) -> Self

Create an error frame

pub fn to_msgpack(&self) -> Result<Vec<u8>, ProtocolError>

Serialize frame to MessagePack bytes

pub fn from_msgpack(bytes: &[u8]) -> Result<Self, ProtocolError>

Deserialize frame from MessagePack bytes

pub fn payload_size(&self) -> usize

Get the payload size

pub fn is_end_stream(&self) -> bool

Check if this is an end-of-stream frame

pub fn is_error(&self) -> bool

Check if this is an error frame

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Frame

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

where __S: Serializer,

Serialize this value into the given Serde serializer.