Enum OwnedFrame

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

Available on crate feature resp2 only.

A RESP2 frame.

Variants

SimpleString(Vec<u8>)

A RESP2 simple string.

Error(String)

A short string representing an error.

Integer(i64)

A signed 64-bit integer.

BulkString(Vec<u8>)

A byte array.

Array(Vec<OwnedFrame>)

An array of frames,

Null

A null value.

Implementations

impl OwnedFrame

pub fn into_bytes_frame(self) -> BytesFrame

Available on crate feature bytes only.

Move the frame contents into a new BytesFrame.

pub fn into_resp3(self) -> Resp3OwnedFrame

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 OwnedFrame

fn clone(&self) -> OwnedFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedFrame

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

Formats the value using the given formatter.

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

where T: FromResp2<OwnedFrame>,

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for ()

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

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

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

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

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

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

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl<T> FromResp2<OwnedFrame> for Option<T>

where T: FromResp2<OwnedFrame>,

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for OwnedFrame

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for String

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl<T> FromResp2<OwnedFrame> for Vec<T>

where T: FromResp2<OwnedFrame>,

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for bool

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for f32

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for f64

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for i128

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for i16

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for i32

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for i64

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for i8

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for isize

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for u128

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for u16

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for u32

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for u64

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for u8

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl FromResp2<OwnedFrame> for usize

Available on crate feature convert only.

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

Convert a frame to the destination type.

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

Convert multiple frames to the destination type.

impl Hash for OwnedFrame

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 OwnedFrame

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

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

Read the number of bytes needed to encode this frame.

fn take(&mut self) -> OwnedFrame

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 Eq for OwnedFrame

impl StructuralPartialEq for OwnedFrame