Enum BorrowedFrame

pub enum BorrowedFrame<'a> {
    SimpleString(&'a [u8]),
    Error(&'a str),
    Integer(i64),
    BulkString(&'a [u8]),
    Array(&'a [BorrowedFrame<'a>]),
    Null,
}

Available on crate feature resp2 only.

A borrowed frame variant, typically used for encoding use cases.

Variants

SimpleString(&'a [u8])

A RESP2 simple string.

Error(&'a str)

A short string representing an error.

Integer(i64)

A signed 64-bit integer.

BulkString(&'a [u8])

A byte array.

Array(&'a [BorrowedFrame<'a>])

An array of frames,

Null

A null value.

Implementations

impl<'a> BorrowedFrame<'a>

pub fn kind(&self) -> FrameKind

Read the FrameKind value for this frame.

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

Return the number of bytes needed to encode this frame.

The int_as_bulkstring argument controls whether integers should be encoded as bulk strings, which is how Redis expects integers in practice.

Trait Implementations

impl<'a> Clone for BorrowedFrame<'a>

fn clone(self: &BorrowedFrame<'a>) -> BorrowedFrame<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BorrowedFrame<'a>

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

Formats the value using the given formatter.

impl Encoder<BorrowedFrame<'_>> for Resp2

Available on crate feature codec only.

type Error = RedisProtocolError

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl<'a> Hash for BorrowedFrame<'a>

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<'a> PartialEq for BorrowedFrame<'a>

fn eq(&self, other: &BorrowedFrame<'a>) -> 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<'a> Eq for BorrowedFrame<'a>

impl<'a> StructuralPartialEq for BorrowedFrame<'a>