Enum Value 

pub enum Value {
    SimpleString(Bytes),
    Error(Bytes),
    Integer(i64),
    BulkString(Bytes),
    Null,
    Array(Vec<Value>),
}

A RESP protocol value.

This enum supports both RESP2 and RESP3 types. RESP3 types are only available when the resp3 feature is enabled.

Variants

SimpleString(Bytes)

Simple string: +OK\r\n

Error(Bytes)

Error: -ERR message\r\n

Integer(i64)

Integer: :1000\r\n

BulkString(Bytes)

Bulk string: $6\r\nfoobar\r\n

Null

Null value. RESP2: $-1\r\n or *-1\r\n RESP3: _\r\n

Array(Vec<Value>)

Array: *2\r\n...

Implementations

impl Value

pub fn simple_string(s: &[u8]) -> Self

Create a simple string value.

pub fn error(msg: &[u8]) -> Self

Create an error value.

pub fn integer(n: i64) -> Self

Create an integer value.

pub fn bulk_string(data: &[u8]) -> Self

Create a bulk string value.

pub fn null() -> Self

Create a null value.

pub fn array(elements: Vec<Value>) -> Self

Create an array value.

pub fn is_null(&self) -> bool

Returns true if this is a null value.

pub fn is_error(&self) -> bool

Returns true if this is an error value.

pub fn is_simple_string(&self) -> bool

Returns true if this is a simple string.

pub fn is_bulk_string(&self) -> bool

Returns true if this is a bulk string.

pub fn is_integer(&self) -> bool

Returns true if this is an integer.

pub fn is_array(&self) -> bool

Returns true if this is an array.

pub fn as_bytes(&self) -> Option<&[u8]>

Returns the value as bytes if it’s a string type (simple or bulk).

pub fn as_integer(&self) -> Option<i64>

Returns the value as an integer.

pub fn as_array(&self) -> Option<&[Value]>

Returns the value as an array.

pub fn parse(data: &[u8]) -> Result<(Self, usize), ParseError>

Parse a RESP value from a byte buffer.

Returns the parsed value and the number of bytes consumed.

Errors

Returns ParseError::Incomplete if more data is needed to complete parsing. Returns other errors for malformed data.

pub fn parse_with_options( data: &[u8], options: &ParseOptions, ) -> Result<(Self, usize), ParseError>

Parse a RESP value from raw bytes with custom options.

This allows configuring DoS protection limits like maximum collection size and bulk string length.

pub fn parse_bytes(data: Bytes) -> Result<(Self, usize), ParseError>

Parse a RESP value zero-copy from a Bytes buffer.

String variants (BulkString, SimpleString, etc.) are returned as Bytes::slice() references into the input — no allocation or copy. Returns the parsed value and the number of bytes consumed.

pub fn parse_bytes_with_options( data: Bytes, options: &ParseOptions, ) -> Result<(Self, usize), ParseError>

Parse a RESP value zero-copy from a Bytes buffer with custom options.

pub fn encode(&self, buf: &mut [u8]) -> usize

Encode this value into a byte buffer.

Returns the number of bytes written.

Panics

Panics if the buffer is too small. Use encoded_len() to check the required size.

pub fn encoded_len(&self) -> usize

Calculate the encoded length of this value.

impl Value

pub const OK: &'static [u8] = b"+OK\r\n"

OK simple string response.

pub const PONG: &'static [u8] = b"+PONG\r\n"

PONG simple string response.

pub const NULL_BULK: &'static [u8] = b"$-1\r\n"

Null bulk string response.

pub const EMPTY_ARRAY: &'static [u8] = b"*0\r\n"

Empty array response.

pub fn encode_ok(buf: &mut [u8]) -> usize

Encode an OK response directly to a buffer.

pub fn encode_pong(buf: &mut [u8]) -> usize

Encode a PONG response directly to a buffer.

pub fn encode_null_bulk(buf: &mut [u8]) -> usize

Encode a null bulk string response directly to a buffer.

pub fn encode_int(buf: &mut [u8], n: i64) -> usize

Encode an integer response directly to a buffer.

pub fn encode_bulk(buf: &mut [u8], data: &[u8]) -> usize

Encode a bulk string response directly to a buffer (zero-copy for data).

pub fn encode_err(buf: &mut [u8], msg: &[u8]) -> usize

Encode an error response directly to a buffer.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl PartialEq for Value

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