Enum Frame

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

A frame in the Redis protocol.

Variants

Simple(String)

Error(String)

Integer(u64)

Bulk(Bytes)

Null

Array(Vec<Frame>)

Implementations

impl Frame

pub fn array() -> Frame

Returns an empty array

pub fn push_bulk(&mut self, bytes: Bytes)

Push a “bulk” frame into the array. self must be an Array frame.

Panics

panics if self is not an array

pub fn push_int(&mut self, value: u64)

Push an “integer” frame into the array. self must be an Array frame.

Panics

panics if self is not an array

pub fn check(src: &mut Cursor<&[u8]>) -> Result<(), FrameError>

Checks if an entire message can be decoded from src

pub fn parse(src: &mut Cursor<&[u8]>) -> Result<Frame, FrameError>

The message has already been validated with scan.

pub fn to_error(&self) -> Error

Converts the frame to an “unexpected frame” error

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

const 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 Display for Frame

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

Formats the value using the given formatter.

impl PartialEq<&str> for Frame

fn eq(&self, other: &&str) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.