Enum redis_protocol::resp3::types::BytesFrame

pub enum BytesFrame {
    BlobString {
        data: Bytes,
        attributes: Option<BytesAttributes>,
    },
    BlobError {
        data: Bytes,
        attributes: Option<BytesAttributes>,
    },
    SimpleString {
        data: Bytes,
        attributes: Option<BytesAttributes>,
    },
    SimpleError {
        data: Str,
        attributes: Option<BytesAttributes>,
    },
    Boolean {
        data: bool,
        attributes: Option<BytesAttributes>,
    },
    Null,
    Number {
        data: i64,
        attributes: Option<BytesAttributes>,
    },
    Double {
        data: f64,
        attributes: Option<BytesAttributes>,
    },
    BigNumber {
        data: Bytes,
        attributes: Option<BytesAttributes>,
    },
    VerbatimString {
        data: Bytes,
        format: VerbatimStringFormat,
        attributes: Option<BytesAttributes>,
    },
    Array {
        data: Vec<BytesFrame>,
        attributes: Option<BytesAttributes>,
    },
    Map {
        data: FrameMap<BytesFrame, BytesFrame>,
        attributes: Option<BytesAttributes>,
    },
    Set {
        data: FrameSet<BytesFrame>,
        attributes: Option<BytesAttributes>,
    },
    Push {
        data: Vec<BytesFrame>,
        attributes: Option<BytesAttributes>,
    },
    Hello {
        version: RespVersion,
        auth: Option<(Str, Str)>,
        setname: Option<Str>,
    },
    ChunkedString(Bytes),
}

Available on crate features resp3 and bytes only.

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

https://github.com/antirez/RESP3/blob/master/spec.md

Variants

BlobString

A blob of bytes.

Fields

data: Bytes

attributes: Option<BytesAttributes>

BlobError

A blob representing an error.

Fields

data: Bytes

attributes: Option<BytesAttributes>

SimpleString

A small string.

The internal data type is Bytes in order to support callers that use this interface to parse a MONITOR stream.

Fields

data: Bytes

attributes: Option<BytesAttributes>

SimpleError

A small string representing an error.

Fields

data: Str

attributes: Option<BytesAttributes>

Boolean

A boolean type.

Fields

data: bool

attributes: Option<BytesAttributes>

Null

A null type.

Number

A signed 64-bit integer.

Fields

data: i64

attributes: Option<BytesAttributes>

Double

A signed 64-bit floating point number.

Fields

data: f64

attributes: Option<BytesAttributes>

BigNumber

A large number not representable as a Number or Double.

This library does not attempt to parse this.

Fields

data: Bytes

attributes: Option<BytesAttributes>

VerbatimString

A string to be displayed without any escaping or filtering.

Fields

data: Bytes

format: VerbatimStringFormat

attributes: Option<BytesAttributes>

Array

An array of frames.

Fields

data: Vec<BytesFrame>

attributes: Option<BytesAttributes>

Map

An unordered map of key-value pairs.

According to the spec keys can be any other RESP3 data type. However, it doesn’t make sense to implement Hash for certain aggregate types. The can_hash function can be used to detect this.

Fields

data: FrameMap<BytesFrame, BytesFrame>

attributes: Option<BytesAttributes>

Set

An unordered collection of other frames with a uniqueness constraint.

Fields

data: FrameSet<BytesFrame>

attributes: Option<BytesAttributes>

Push

Out-of-band data.

Fields

data: Vec<BytesFrame>

attributes: Option<BytesAttributes>

Hello

A special frame type used when first connecting to the server to describe the protocol version and optional credentials.

Fields

version: RespVersion

auth: Option<(Str, Str)>

setname: Option<Str>

ChunkedString(Bytes)

One chunk of a streaming blob.

Implementations

impl BytesFrame

pub fn to_owned_frame(&self) -> OwnedFrame

Copy the frame contents into a new OwnedFrame.

Trait Implementations

impl Clone for BytesFrame

fn clone(&self) -> BytesFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BytesFrame

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

Formats the value using the given formatter.

impl Encoder<BytesFrame> for Resp3

Available on crate feature codec only.

type Error = RedisProtocolError

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl From<bool> for BytesFrame

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for BytesFrame

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i64> for BytesFrame

fn from(value: i64) -> Self

Converts to this type from the input type.

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

where T: FromResp3<BytesFrame>,

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for ()

Available on crate feature convert only.

fn from_frame(_: BytesFrame) -> 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 FromResp3<BytesFrame> for Bytes

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for BytesFrame

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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> FromResp3<BytesFrame> for HashMap<K, V, S>

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

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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> FromResp3<BytesFrame> for HashSet<V, S>

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

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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> FromResp3<BytesFrame> for Option<T>

where T: FromResp3<BytesFrame>,

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for Str

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for String

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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> FromResp3<BytesFrame> for Vec<T>

where T: FromResp3<BytesFrame>,

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for bool

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for f32

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for f64

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for i128

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for i16

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for i32

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for i64

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for i8

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for isize

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for u128

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for u16

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for u32

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for u64

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 FromResp3<BytesFrame> for u8

Available on crate feature convert only.

fn from_frame(frame: BytesFrame) -> 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 FromResp3<BytesFrame> for usize

Available on crate feature convert only.

fn from_frame(value: BytesFrame) -> 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 BytesFrame

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

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

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

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

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

impl Resp3Frame for BytesFrame

fn add_attributes( &mut self, attributes: Self::Attributes ) -> Result<(), RedisProtocolError>

Attempt to add attributes to the frame, extending the existing attributes if needed.

type Attributes = HashMap<BytesFrame, BytesFrame>

fn from_buffer( target: FrameKind, buf: impl IntoIterator<Item = Self>, attributes: Option<Self::Attributes> ) -> Result<Self, RedisProtocolError>

Create the target aggregate type based on a buffered set of chunked frames.

fn attributes(&self) -> Option<&Self::Attributes>

Read the attributes attached to the frame.

fn take_attributes(&mut self) -> Option<Self::Attributes>

Take the attributes off this frame.

fn attributes_mut(&mut self) -> Option<&mut Self::Attributes>

Read a mutable reference to any attributes attached to the frame.

fn new_empty() -> Self

Create a new empty frame with attribute support.

fn new_end_stream() -> Self

Create a new frame that terminates a stream.

fn len(&self) -> usize

A context-aware length function that returns the length of the inner frame contents.

fn take(&mut self) -> BytesFrame

Replace self with Null, returning the original value.

fn kind(&self) -> FrameKind

Read the associated FrameKind.

fn is_end_stream_frame(&self) -> bool

Whether the frame is an empty chunked string, signifying the end of a chunked string stream.

fn verbatim_string_format(&self) -> Option<&VerbatimStringFormat>

If the frame is a verbatim string then read the associated format.

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

Read the frame as a string slice if it can be parsed as a UTF-8 string without allocating.

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

Attempt to convert the frame to a bool.

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

Read the frame as a String if it can be parsed as a UTF-8 string.

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

Attempt to read the frame as a byte slice.

fn encode_len(&self) -> usize

Read the number of bytes necessary to represent the frame and any associated attributes.

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: FromResp3<Self>,

Available on crate feature convert only.

Convert the frame to another type.

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

type Error = RedisProtocolError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for BytesFrame

impl StructuralPartialEq for BytesFrame