Enum Frame

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

An enum representing a Frame of data.

Variants

SimpleString(Bytes)

A short non binary-safe string.

Error(Str)

A short non binary-safe string representing an error.

Integer(i64)

A signed 64 bit integer.

BulkString(Bytes)

A binary-safe string.

Array(Vec<Frame>)

An array of frames, arbitrarily nested.

Null

A null value.

Implementations

impl Frame

pub fn take(&mut self) -> Frame

Replace self with Null, returning the original value.

pub fn is_error(&self) -> bool

Whether or not the frame is an error.

pub fn is_normal_pubsub(&self) -> bool

Whether or not the frame represents a publish-subscribe message, but not a pattern publish-subscribe message.

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 without allocating.

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) -> Option<Redirection>

Attempt to parse the frame as a cluster redirection.

pub fn encode_len(&self) -> Result<usize, RedisProtocolError>

Attempt to read the number of bytes needed to encode this frame.

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<'a> From<&'a Redirection> for Frame

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

Converts to this type from the input type.

impl From<Redirection> for Frame

fn from(redirection: Redirection) -> Self

Converts to this type from the input type.

impl PartialEq for Frame

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

impl Eq for Frame

impl StructuralPartialEq for Frame