Enum BorrowedFrame

pub enum BorrowedFrame<'a> {
    BlobString {
        data: &'a [u8],
        attributes: Option<BorrowedAttrs<'a>>,
    },
    BlobError {
        data: &'a [u8],
        attributes: Option<BorrowedAttrs<'a>>,
    },
    SimpleString {
        data: &'a [u8],
        attributes: Option<BorrowedAttrs<'a>>,
    },
    SimpleError {
        data: &'a str,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Boolean {
        data: bool,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Null,
    Number {
        data: i64,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Double {
        data: f64,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    BigNumber {
        data: &'a [u8],
        attributes: Option<BorrowedAttrs<'a>>,
    },
    VerbatimString {
        data: &'a [u8],
        format: VerbatimStringFormat,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Array {
        data: &'a [BorrowedFrame<'a>],
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Map {
        data: &'a FrameMap<BorrowedFrame<'a>, BorrowedFrame<'a>>,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Set {
        data: &'a FrameSet<BorrowedFrame<'a>>,
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Push {
        data: &'a [BorrowedFrame<'a>],
        attributes: Option<BorrowedAttrs<'a>>,
    },
    Hello {
        version: RespVersion,
        auth: Option<(&'a str, &'a str)>,
        setname: Option<&'a str>,
    },
    ChunkedString(&'a [u8]),
}

Available on crate feature resp3 only.

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

Variants

BlobString

A blob of bytes.

Fields

data: &'a [u8]

attributes: Option<BorrowedAttrs<'a>>

BlobError

A blob representing an error.

Fields

data: &'a [u8]

attributes: Option<BorrowedAttrs<'a>>

SimpleString

A small string.

Fields

data: &'a [u8]

attributes: Option<BorrowedAttrs<'a>>

SimpleError

A small string representing an error.

Fields

data: &'a str

attributes: Option<BorrowedAttrs<'a>>

Boolean

A boolean type.

Fields

data: bool

attributes: Option<BorrowedAttrs<'a>>

Null

A null type.

Number

A signed 64-bit integer.

Fields

data: i64

attributes: Option<BorrowedAttrs<'a>>

Double

A signed 64-bit floating point number.

Fields

data: f64

attributes: Option<BorrowedAttrs<'a>>

BigNumber

A large number not representable as a Number or Double.

Fields

data: &'a [u8]

attributes: Option<BorrowedAttrs<'a>>

VerbatimString

A string to be displayed without any escaping or filtering.

Fields

data: &'a [u8]

format: VerbatimStringFormat

attributes: Option<BorrowedAttrs<'a>>

Array

An array of frames.

Fields

data: &'a [BorrowedFrame<'a>]

attributes: Option<BorrowedAttrs<'a>>

Map

An unordered map of key-value pairs.

Fields

data: &'a FrameMap<BorrowedFrame<'a>, BorrowedFrame<'a>>

attributes: Option<BorrowedAttrs<'a>>

Set

An unordered collection of other frames with a uniqueness constraint.

Fields

data: &'a FrameSet<BorrowedFrame<'a>>

attributes: Option<BorrowedAttrs<'a>>

Push

Out-of-band data.

Fields

data: &'a [BorrowedFrame<'a>]

attributes: Option<BorrowedAttrs<'a>>

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<(&'a str, &'a str)>

setname: Option<&'a str>

ChunkedString(&'a [u8])

One chunk of a streaming blob.

Implementations

impl<'a> BorrowedFrame<'a>

pub fn kind(&self) -> FrameKind

Read the FrameKind value for this frame.

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

Return the number of byte necessary to encode this frame.

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 Resp3

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 Eq for BorrowedFrame<'_>

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