Module types

RESP3 frame types.

Structs

Auth

Authentication information used in the HELLO request.

StreamedFrame

A helper struct for reading and managing streaming data types.

Enums

DecodedFrame

Wrapper enum around a decoded frame that supports streaming frames.

Frame

An enum describing the possible data types in RESP3 along with the corresponding Rust data type to represent the payload.

FrameKind

The type of frame without any associated data.

RespVersion

The RESP version used in the HELLO request.

VerbatimStringFormat

The format of a verbatim string frame.

Constants

ARRAY_BYTE

Byte prefix before an array type.

ATTRIBUTE_BYTE

Byte prefix before an attribute type.

AUTH

Byte representation of AUTH.

BIG_NUMBER_BYTE

Byte prefix before a big number type.

BLOB_ERROR_BYTE

Byte prefix before a blob error type.

BLOB_STRING_BYTE

Byte prefix before a blob string type.

BOOLEAN_BYTE

Byte prefix before a boolean type.

BOOL_FALSE_BYTES

Byte representation of false.

BOOL_TRUE_BYTES

Byte representation of true.

CHUNKED_STRING_BYTE

Byte representation of a chunked string.

DOUBLE_BYTE

Byte prefix before a Double type.

EMPTY_SPACE

Byte representation of an empty space.

END_STREAM_AGGREGATE_BYTES

The terminating bytes when a streaming operation is done from an aggregate type.

END_STREAM_BYTE

Byte used to signify the end of a stream.

END_STREAM_STRING_BYTES

The terminating bytes when a streaming operation is done from a blob string.

HELLO

Byte representation of HELLO.

INFINITY

Byte representation of positive infinity.

MAP_BYTE

Byte prefix before a map type.

NEG_INFINITY

Byte representation of negative infinity.

NULL

The binary representation of NULL in RESP3.

NULL_BYTE

Byte prefix before a NULL value.

NUMBER_BYTE

Byte prefix before a Number type.

PATTERN_PUBSUB_PREFIX

Prefix on pubsub messages from a pattern matching subscription.

PUBSUB_PREFIX

Prefix on normal pubsub messages.

PUBSUB_PUSH_PREFIX

Prefix on RESP3 push pubsub messages.

PUSH_BYTE

Byte prefix before a push type.

SET_BYTE

Byte prefix before a set type.

SIMPLE_ERROR_BYTE

Byte prefix before a simple error type.

SIMPLE_STRING_BYTE

Byte prefix before a simple string type.

STREAMED_LENGTH_BYTE

Byte prefix on a streamed type, following the byte that identifies the type.

VERBATIM_FORMAT_BYTE

Byte used to separate the verbatim string from the format prefix.

VERBATIM_STRING_BYTE

Byte prefix before a verbatim string type.

Type Aliases

Attributes

Additional information returned alongside a frame.

FrameMap

A map struct for frames.

FrameSet

A set struct for frames.