Enum RangeFrame

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

Available on crate feature resp3 only.

A reference-free frame type representing ranges into an associated buffer, typically used to implement zero-copy parsing.

Variants

BlobString

A blob of bytes.

Fields

data: (usize, usize)

attributes: Option<RangeAttributes>

BlobError

A blob representing an error.

Fields

data: (usize, usize)

attributes: Option<RangeAttributes>

SimpleString

A small string.

Fields

data: (usize, usize)

attributes: Option<RangeAttributes>

SimpleError

A small string representing an error.

Fields

data: (usize, usize)

attributes: Option<RangeAttributes>

Boolean

A boolean type.

Fields

data: bool

attributes: Option<RangeAttributes>

Null

A null type.

Number

A signed 64-bit integer.

Fields

data: i64

attributes: Option<RangeAttributes>

Double

A signed 64-bit floating point number.

Fields

data: f64

attributes: Option<RangeAttributes>

BigNumber

A large number not representable as a Number or Double.

Fields

data: (usize, usize)

attributes: Option<RangeAttributes>

VerbatimString

A string to be displayed without any escaping or filtering.

Fields

data: (usize, usize)

format: VerbatimStringFormat

attributes: Option<RangeAttributes>

Array

An array of frames.

Fields

data: Vec<RangeFrame>

attributes: Option<RangeAttributes>

Map

An unordered map of key-value pairs.

Fields

data: FrameMap<RangeFrame, RangeFrame>

attributes: Option<RangeAttributes>

Set

An unordered collection of other frames with a uniqueness constraint.

Fields

data: FrameSet<RangeFrame>

attributes: Option<RangeAttributes>

Push

Out-of-band data.

Fields

data: Vec<RangeFrame>

attributes: Option<RangeAttributes>

Hello

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

Fields

version: RespVersion

username: Option<(usize, usize)>

password: Option<(usize, usize)>

setname: Option<(usize, usize)>

ChunkedString((usize, usize))

One chunk of a streaming blob.

Implementations

impl RangeFrame

pub fn kind(&self) -> FrameKind

Read the associated FrameKind.

pub fn len(&self) -> usize

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

This does not return the encoded length, but rather the length of the contents of the frame such as the number of elements in an array, the size of any inner buffers, etc.

Note: Null has a length of 0 and Hello, Number, Double, and Boolean have a length of 1.

pub fn add_attributes( &mut self, attributes: RangeAttributes, ) -> Result<(), RedisProtocolError>

Add attributes to the frame.

pub fn new_end_stream() -> Self

Trait Implementations

impl Clone for RangeFrame

fn clone(&self) -> RangeFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeFrame

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

Formats the value using the given formatter.

impl Hash for RangeFrame

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 RangeFrame

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

impl StructuralPartialEq for RangeFrame