Enum Frame

pub enum Frame {
    SimpleString(String),
    SimpleError(String),
    Integer(i64),
    BulkString(Bytes),
    Array(Vec<Frame>),
    Null,
    Boolean(bool),
    Double(f64),
    BigNumber(BigInt),
    BulkError(Bytes),
    VerbatimString(Bytes, Bytes),
    Map(Vec<(Frame, Frame)>),
    Attribute,
    Set(Vec<Frame>),
    Push,
}

Frame represents a single RESP data transmit unit over the socket.

more on the RESP protocol can be found here

Variants

SimpleString(String)

SimpleError(String)

Integer(i64)

BulkString(Bytes)

Array(Vec<Frame>)

Null

Boolean(bool)

Double(f64)

BigNumber(BigInt)

BulkError(Bytes)

VerbatimString(Bytes, Bytes)

Map(Vec<(Frame, Frame)>)

Attribute

Set(Vec<Frame>)

Push

Implementations

impl Frame

pub const fn array() -> Self

Returns an empty Array Frame.

pub fn push_frame_to_array(&mut self, frame: Frame) -> Result<()>

A utility method to push a Frame into an Array/Set Frame.

Arguments

• frame - A Frame to be pushed into the Array

Panics

This method will panic if the Frame is not an Array or Set.

pub fn push_frame_to_map(&mut self, key: Frame, value: Frame) -> Result<()>

A utility method to push a Frame into a Map Frame.

Arguments

• key - A Frame to be used as a key in the Map
• value - A Frame to be used as a value in the Map

Panics

This method will panic if the Frame is not a Map.

pub async fn serialize(&self) -> Result<Bytes>

Serializes a Frame into a bytes buffer.

The returned value is a smart pointer only counting reference. It is cheap to clone. Caller can get the underlying slice by calling as_slice or as_ref on the returned value. It is almost 0 cost to get the slice.

Returns

A Result containing the serialized bytes buffer

pub async fn deserialize(buf: Bytes) -> Result<Frame>

Deserializes from the buffer into a Frame.

The method reads from the buffer and parses it into a Frame.

Arguments

• buf - An immutable read buffer containing the serialized Frame

Returns

A Result containing the deserialized Frame

pub fn try_parse(cursor: &mut Cursor<&[u8]>) -> Result<Frame>

Tries parsing a Frame from the buffer.

This method wraps the input with a cursor to track the current version as we need to make resursive calls. Using a cursor avoids the need to split the buffer or passing an additional parameter.

Returns

• Ok(usize) if the buffer contains a complete frame, the number of bytes needed to parse the frame
• Err(RedisError::IncompleteFrame) if the buffer contains an incomplete frame
• Err(RedisError::InvalidFrame) if the buffer contains an invalid frame

Trait Implementations

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