Enum redis_protocol::types::Frame

pub enum Frame {
    SimpleString(String),
    Error(String),
    Integer(i64),
    BulkString(Vec<u8>),
    Array(Vec<Frame>),
    Moved(String),
    Ask(String),
    Null,
}

An enum representing a Frame of data. Frames are recursively defined to account for arrays.

Variants

SimpleString(String)

Error(String)

Integer(i64)

BulkString(Vec<u8>)

Array(Vec<Frame>)

Moved(String)

Ask(String)

Null

Implementations

impl Frame

pub fn is_error(&self) -> bool

Whether or not the frame is an error.

pub fn is_pubsub_message(&self) -> bool

Whether or not the frame represents a message on a publish-subscribe channel.

pub fn is_pattern_pubsub_message(&self) -> bool

Whether or not the frame represents a message on a publish-subscribe channel matched against a pattern subscription.

pub fn kind(&self) -> FrameKind

Read the FrameKind value for this frame.

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

Attempt to read the frame value as a string slice.

pub fn is_string(&self) -> bool

Whether or not the frame is a simple string or bulk string.

pub fn is_null(&self) -> bool

Whether or not the frame is Null.

pub fn is_array(&self) -> bool

Whether or not the frame is an array of frames.

pub fn is_integer(&self) -> bool

Whether or not the frame is an integer.

pub fn is_moved_or_ask_error(&self) -> bool

Whether or not the framed is a a Moved or Ask error.

pub fn to_string(&self) -> Option<String>

pub fn parse_as_pubsub(self) -> Result<(String, String), Self>

Attempt to parse the frame as a publish-subscribe message, returning the (channel, message) tuple if successful, or the original frame if the inner data is not a publish-subscribe message.

pub fn to_redirection(&self) -> Result<Redirection, RedisProtocolError<'_>>

Attempt to parse the frame as a cluster redirection.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

pub 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 Eq for Frame

impl<'a> From<&'a Redirection> for Frame

fn from(redirection: &'a Redirection) -> Self

Performs the conversion.

impl From<Redirection> for Frame

fn from(redirection: Redirection) -> Self

Performs the conversion.

impl PartialEq<Frame> for Frame

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Frame

impl StructuralPartialEq for Frame