Struct StreamingFrame 

pub struct StreamingFrame {
    pub frame_type: FrameType,
    pub flags: FrameFlags,
    pub chunk_size: usize,
    pub checksum: u32,
    pub payload: Vec<u8>,
}

Streaming frame structure

Frame layout:

┌──────────┬──────────┬──────────────┬──────────┬─────────────┐
│ FRAME_ID │  FLAGS   │ CHUNK_SIZE   │ CHECKSUM │   PAYLOAD   │
│ (1 byte) │ (1 byte) │  (VarInt)    │ (4 bytes)│  (variable) │
└──────────┴──────────┴──────────────┴──────────┴─────────────┘

Fields

frame_type: FrameType

Frame type identifier

flags: FrameFlags

Frame flags

chunk_size: usize

Size of the payload chunk (0 for BEGIN/END/ERROR frames)

checksum: u32

XOR checksum of the payload (0 for BEGIN/END frames)

payload: Vec<u8>

Frame payload data

Implementations

impl StreamingFrame

pub fn begin() -> Self

Creates a new BEGIN frame

pub fn chunk(payload: Vec<u8>, has_more: bool) -> Self

Creates a new CHUNK frame with payload

pub fn end() -> Self

Creates a new END frame

pub fn error(message: String) -> Self

Creates a new ERROR frame with error message

pub fn compute_xor_checksum(data: &[u8]) -> u32

Computes XOR checksum for payload data

pub fn validate_checksum(&self) -> Result<(), StreamingError>

Validates the checksum of this frame

Trait Implementations

impl Clone for StreamingFrame

fn clone(&self) -> StreamingFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingFrame

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

Formats the value using the given formatter.

impl PartialEq for StreamingFrame

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