Module types

Source
Available on crate feature resp3 only.
Expand description

RESP3 frame types.

Structs§

StreamedFrame
A helper struct for reading and managing streaming data types.
StreamedRangeFrame
A frame type representing ranges into an associated buffer that contains the starting portion of a streaming frame.

Enums§

BorrowedAttrs
A borrowed attributes type, typically used with BorrowedFrame for encoding use cases.
BorrowedFrame
A borrowed frame variant, typically used for encoding use cases.
BytesFramebytes
A RESP3 frame that uses Bytes and Str as the underlying buffer type.
DecodedFrame
An enum describing the possible return types from the stream decoding interface.
DecodedRangeFrame
A reference-free frame type representing ranges into an associated buffer, typically used to implement zero-copy parsing.
FrameKind
The type of frame without any associated data.
OwnedFrame
An enum describing a RESP3 frame that uses owned byte containers.
RangeFrame
A reference-free frame type representing ranges into an associated buffer, typically used to implement zero-copy parsing.
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.
NAN
Byte representation of NaN.
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.
PUSH_BYTE
Byte prefix before a push type.
SETNAME
Byte representation of SETNAME.
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.

Traits§

Resp3Frame
Generic operations on a RESP3 frame.

Type Aliases§

BytesAttributesbytes
Additional information returned alongside a BytesFrame.
FrameMap
A map struct for frames that uses either indexmap::IndexMap, hashbrown::HashMap, or std::collections::HashMap depending on the enabled feature flags.
FrameSet
A map struct for frames that uses either indexmap::IndexSet, hashbrown::HashSet, or std::collections::HashSet depending on the enabled feature flags.
OwnedAttributes
Additional information returned alongside an OwnedFrame.
RangeAttributes
Additional information returned alongside an RangeFrame.