Enum Frame 

pub enum Frame {
    SimpleString(Bytes),
    Error(Bytes),
    Integer(i64),
    BulkString(Option<Bytes>),
    Array(Option<Vec<Frame>>),
}

A parsed RESP2 frame.

Variants

SimpleString(Bytes)

Simple string: +OK\r\n

Error(Bytes)

Error: -ERR message\r\n

Integer(i64)

Integer: :42\r\n

BulkString(Option<Bytes>)

Bulk string: $6\r\nfoobar\r\n

Array(Option<Vec<Frame>>)

Array: *N\r\n...

Implementations

impl Frame

pub fn as_bytes(&self) -> Option<&Bytes>

Returns the bytes if this is a SimpleString, Error, or BulkString.

For BulkString(None) (null), returns None.

pub fn as_str(&self) -> Option<&str>

Returns the string data as a UTF-8 &str, if this is a string-like frame and contains valid UTF-8.

pub fn as_integer(&self) -> Option<i64>

Returns the integer value if this is an Integer frame.

pub fn as_array(&self) -> Option<&[Frame]>

Returns a reference to the array items if this is an Array.

For Array(None) (null), returns None.

pub fn into_array(self) -> Result<Vec<Frame>, Frame>

Consumes the frame and returns the array items.

Returns Err(self) if this is not a non-null Array.

pub fn into_bulk_string(self) -> Result<Bytes, Frame>

Consumes the frame and returns the bulk string bytes.

Returns Err(self) if this is not a non-null BulkString.

pub fn is_null(&self) -> bool

Returns true if this is a null bulk string or null array.

pub fn is_error(&self) -> bool

Returns true 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 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