Enum Frame 

pub enum Frame {
    Simple(String),
    Error(String),
    Integer(i64),
    Bulk(Bytes),
    Array(Vec<Frame>),
    Null,
    Map(Vec<(Frame, Frame)>),
}

A single RESP3 protocol frame.

Covers the core types needed for basic Redis-compatible commands: strings, errors, integers, bulk data, arrays, null, and maps.

Variants

Simple(String)

Simple string response, e.g. +OK\r\n. Used for short, non-binary status replies.

Error(String)

Error response, e.g. -ERR unknown command\r\n.

Integer(i64)

64-bit signed integer, e.g. :42\r\n.

Bulk(Bytes)

Bulk (binary-safe) string, e.g. $5\r\nhello\r\n. Uses Bytes for zero-copy-friendly handling.

Array(Vec<Frame>)

Ordered array of frames, e.g. *2\r\n+hello\r\n+world\r\n.

Null

Null value, e.g. _\r\n.

Map(Vec<(Frame, Frame)>)

Ordered map of key-value frame pairs, e.g. %1\r\n+key\r\n+val\r\n.

Uses Vec instead of HashMap to preserve insertion order (RESP3 maps are ordered) and because typical maps in Redis responses are small enough that linear scan beats hashing overhead.

Implementations

impl Frame

pub fn serialize(&self, dst: &mut BytesMut)

Serializes this frame into the provided buffer.

Writes the full RESP3 wire representation, including type prefix and trailing \r\n delimiters. Nested structures are bounded to [MAX_SERIALIZE_DEPTH] levels to prevent stack overflow.

impl Frame

pub fn is_null(&self) -> bool

Returns true if this frame is a null value.

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 PartialEq for Frame

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

impl StructuralPartialEq for Frame