Enum BytesFrame 

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

Available on crate feature bytes only.

A RESP2 frame that uses Bytes and Str as the underlying buffer type.

Variants

SimpleString(Bytes)

A RESP2 simple string.

Error(Str)

A short string representing an error.

Integer(i64)

A signed 64-bit integer.

BulkString(Bytes)

A byte array.

Array(Vec<BytesFrame>)

An array of frames.

Null

A null value.

Implementations

impl BytesFrame

pub fn to_owned_frame(&self) -> OwnedFrame

Available on crate feature resp2 only.

Copy the contents into a new OwnedFrame.

pub fn into_resp3(self) -> Resp3BytesFrame

Available on crate feature resp2 only.

Convert the frame to RESP3.

For the most part RESP3 is a superset of RESP2, but there is one notable difference with publish-subscribe messages - in RESP3 pubsub arrays have an additional prefix frame with the SimpleString value “pubsub”. This function will add this frame.

Trait Implementations

impl Clone for BytesFrame

Available on crate feature resp2 only.

fn clone(&self) -> BytesFrame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BytesFrame

Available on crate feature resp2 only.

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

Formats the value using the given formatter.

impl Encoder<BytesFrame> for Resp2

Available on crate feature codec only.

type Error = RedisProtocolError

The type of encoding errors.

fn encode( &mut self, item: Resp2Frame, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl<T, const N: usize> FromResp2<BytesFrame> for [T; N]

where T: FromResp2<BytesFrame>,

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<[T; N], RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for ()

Available on crate feature convert only.

fn from_frame(_: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for Bytes

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for BytesFrame

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl<K, V, S> FromResp2<BytesFrame> for HashMap<K, V, S>

where K: FromResp2<BytesFrame> + Eq + Hash, V: FromResp2<BytesFrame>, S: BuildHasher + Default,

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl<V, S> FromResp2<BytesFrame> for HashSet<V, S>

where V: FromResp2<BytesFrame> + Hash + Eq, S: BuildHasher + Default,

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl<T> FromResp2<BytesFrame> for Option<T>

where T: FromResp2<BytesFrame>,

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Option<T>, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for Str

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for String

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl<T> FromResp2<BytesFrame> for Vec<T>

where T: FromResp2<BytesFrame>,

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Vec<T>, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for bool

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for f32

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for f64

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for i128

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<i128, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for i16

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<i16, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for i32

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<i32, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for i64

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<i64, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for i8

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<i8, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for isize

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<isize, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for u128

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<u128, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for u16

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<u16, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for u32

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<u32, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for u64

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<u64, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for u8

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> Result<Self, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl FromResp2<BytesFrame> for usize

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> Result<usize, RedisProtocolError>

Available on crate feature resp2 only.

Convert a frame to the destination type.

fn from_frames(frames: Vec<F>) -> Result<Vec<Self>, RedisProtocolError>

Available on crate feature resp2 only.

Convert multiple frames to the destination type.

impl Hash for BytesFrame

Available on crate feature resp2 only.

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BytesFrame

Available on crate feature resp2 only.

fn eq(&self, other: &BytesFrame) -> 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 Resp2Frame for BytesFrame

Available on crate feature resp2 only.

fn encode_len(&self, int_as_bulkstring: bool) -> usize

Read the number of bytes needed to encode this frame.

fn take(&mut self) -> BytesFrame

Replace self with Null, returning the original value.

fn kind(&self) -> FrameKind

Read the FrameKind value for this frame.

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

Attempt to read the frame value as a string slice.

fn as_bool(&self) -> Option<bool>

Convert the value to a boolean.

fn as_bytes(&self) -> Option<&[u8]>

Attempt to read the frame value as a byte slice.

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

Copy and read the inner value as a string, if possible.

fn is_normal_pubsub_message(&self) -> bool

Whether the frame is a message from a subscribe call.

fn is_pattern_pubsub_message(&self) -> bool

Whether the frame is a message from a psubscribe call.

fn is_shard_pubsub_message(&self) -> bool

Whether the frame is a message from a ssubscribe call.

fn is_single_element_vec(&self) -> bool

Available on crate feature convert only.

Whether frame is a bulk array with a single element.

fn pop_or_take(self) -> Self

Available on crate feature convert only.

Pop an element from the inner array or return the original frame.

fn is_redirection(&self) -> bool

Whether the frame is a MOVED or ASK redirection.

fn as_f64(&self) -> Option<f64>

Convert the frame to a double.

fn convert<T>(self) -> Result<T, RedisProtocolError>

where Self: Sized, T: FromResp2<Self>,

Available on crate feature convert only.

Convert the frame to another type.

impl<B: Into<Bytes>> TryFrom<(FrameKind, B)> for BytesFrame

Available on crate feature resp2 only.

type Error = RedisProtocolError

The type returned in the event of a conversion error.

fn try_from((kind, buf): (FrameKind, B)) -> Result<Self, RedisProtocolError>

Performs the conversion.

impl Eq for BytesFrame

Available on crate feature resp2 only.

impl StructuralPartialEq for BytesFrame

Available on crate feature resp2 only.