Enum Value

pub enum Value {
    Int(i64),
    Str(String),
    Err(String),
    BStr(Option<String>),
    Array(Option<Vec<Value>>),
}

In-memory representation of a RESP value.

Variants

Int(i64)

An integer.

Str(String)

A simple string.

Err(String)

An error.

BStr(Option<String>)

A bulk string.

Array(Option<Vec<Value>>)

An array.

Implementations

impl Value

pub fn encode(&self) -> String

Encodes a Value as a string.

Examples

let error = Value::err("ERR");

assert_eq!(error.encode(), "-ERR\r\n");

pub fn encode_bytes(&self) -> Vec<u8>

Encodes a Value as a vector of bytes.

Examples

let error = Value::err("ERR");

assert_eq!(&error.encode_bytes(), b"-ERR\r\n");

pub fn is_null(&self) -> bool

Checks if a Value is null.

NOTE: Only the Array and BStr types can represent a null value.

Examples

let name = Value::BStr(None);

assert!(name.is_null());

let name = Value::b_str(Some("Josh"));

assert!(!name.is_null());

pub fn is_empty(&self) -> bool

Checks is a Value is empty.

Examples

let error = Value::err("");

assert!(error.is_empty());

let error = Value::err("ERR");

assert!(!error.is_empty())

Null values count as empty too:

let name = Value::BStr(None);

assert!(name.is_empty());

pub fn int(value: i64) -> Self

Constructs a new integer value.

NOTE: Using this function has no benefits, it’s simply here for completeness.

Examples

let age = Value::int(-3);

println!("{:?}", age);

pub fn str<T>(value: T) -> Self

where T: ToString,

Constructs a new simple string.

Examples

let status = Value::str("OK");

println!("{:?}", status);

pub fn err<T>(error: T) -> Self

where T: ToString,

Constructs a new error.

Examples

let err = Value::err("ERR");

println!("{:?}", err);

pub fn b_str<T>(value: Option<T>) -> Self

where T: ToString,

Constructs a new bulk string.

Examples

let b_str = Value::b_str(Some("foobar"));

println!("{:?}", b_str);

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

Constructs a new array value.

NOTE: Using this function has no benefits, it’s simply here for completeness.

Examples

let users = Value::array(Some(vec![
    Value::b_str(Some("foo")),
    Value::b_str(Some("bar")),
    Value::b_str(Some("baz"))
]));

println!("{:?}", users);

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<'_>) -> FmtResult

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl From<i64> for Value

fn from(value: i64) -> Self

Converts to this type from the input type.

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 Eq for Value

impl StructuralPartialEq for Value