1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
//! Builder for constructing RESP2/3 frames
//!
//! Generic wrapper mainly used as helper for creating RESP frames.
//! However, it can also be used to execute custom/arbitrary commands. See [CustomCommand](crate::commands::custom) for more details.
//!
//! # Creating generic frames
//! The following example demonstrates the creation of command frame for [HGET](https://redis.io/commands/hget/).
//! ```
//! use embedded_redis::commands::builder::CommandBuilder;
//! use redis_protocol::resp2::types::Frame as Resp2Frame;
//!
//! let _frame: Resp2Frame = CommandBuilder::new("HGET")
//! .arg_static("field1")
//! .arg_static("foo")
//! .into();
//! ```
//! # Improved performance
//! For best performance, especially with large amounts of data, it is recommended to use [Bytes](<https://docs.rs/bytes/latest/bytes/>).
//! ```
//!# use bytes::Bytes;
//! use embedded_redis::commands::builder::CommandBuilder;
//!# use redis_protocol::resp2::types::Frame as Resp2Frame;
//!#
//! // Using Bytes avoids data copy, as clone() is shallow
//! let value = Bytes::from_static("Large value".as_bytes());
//!
//! let _frame: Resp2Frame = CommandBuilder::new("HSET")
//! .arg_static("myhash")
//! .arg_static("field1")
//! .arg(&value)
//! .into();
//! ```
use crate::commands::custom::CustomCommand;
use alloc::collections::BTreeMap;
use alloc::string::{String, ToString};
use alloc::vec;
use alloc::vec::Vec;
use bytes::Bytes;
use redis_protocol::resp2::prelude::Frame;
use redis_protocol::resp2::types::Frame as Resp2Frame;
use redis_protocol::resp3::types::Frame as Resp3Frame;
/// Builder for constructing RESP2/3 frames
#[derive(Clone, Default)]
pub struct CommandBuilder {
pub(crate) elements: Vec<Bytes>,
}
impl CommandBuilder {
pub fn new(keyword: &'static str) -> Self {
CommandBuilder {
elements: vec![Bytes::from_static(keyword.as_bytes())],
}
}
/// Converts builder to command ready for being sent by Client
pub fn to_command(self) -> CustomCommand {
self.into()
}
/// Adds a static argument
pub fn arg_static(mut self, arg: &'static str) -> Self {
self.elements.push(Bytes::from_static(arg.as_bytes()));
self
}
/// Adds a static argument
pub fn arg_static_option(mut self, arg: Option<&'static str>) -> Self {
if let Some(arg_str) = arg {
self.elements.push(Bytes::from_static(arg_str.as_bytes()));
}
self
}
/// Adds cased string of uint
pub fn arg_uint(mut self, arg: usize) -> Self {
self.elements.push(Bytes::from(arg.to_string()));
self
}
/// Adds a byte argument
/// Note: Besides static, the most efficient way caused by the nature how Bytes cloning is working
pub fn arg(mut self, arg: &Bytes) -> Self {
self.elements.push(arg.clone());
self
}
/// Just adding byte if option is Some
pub fn arg_option(mut self, arg: Option<&Bytes>) -> Self {
if let Some(inner) = arg {
self.elements.push(inner.clone());
}
self
}
}
impl From<CommandBuilder> for Resp2Frame {
fn from(builder: CommandBuilder) -> Self {
let mut frames = Vec::with_capacity(builder.elements.len());
for byte in builder.elements {
frames.push(Resp2Frame::BulkString(byte));
}
Resp2Frame::Array(frames)
}
}
impl From<CommandBuilder> for Resp3Frame {
fn from(builder: CommandBuilder) -> Self {
let mut frames = Vec::with_capacity(builder.elements.len());
for byte in builder.elements {
frames.push(Resp3Frame::BlobString {
data: byte,
attributes: None,
});
}
Resp3Frame::Array {
data: frames,
attributes: None,
}
}
}
impl From<CommandBuilder> for CustomCommand {
fn from(builder: CommandBuilder) -> Self {
CustomCommand::new(builder)
}
}
/// Unification for `to_string()` of RESP2/3 frames
pub trait ToStringOption {
fn to_string_option(&self) -> Option<String>;
}
impl ToStringOption for Resp2Frame {
fn to_string_option(&self) -> Option<String> {
self.to_string()
}
}
impl ToStringOption for Resp3Frame {
fn to_string_option(&self) -> Option<String> {
self.to_string()
}
}
/// Unification for null check of RESP2/3 frames
pub trait IsNullFrame {
fn is_null_frame(&self) -> bool;
}
impl IsNullFrame for Resp2Frame {
fn is_null_frame(&self) -> bool {
self.is_null()
}
}
impl IsNullFrame for Resp3Frame {
fn is_null_frame(&self) -> bool {
self.is_null()
}
}
/// Unification for extracting integer value of Frames
pub trait ToInteger {
/// Returns the inner integer value, None in case frame is not integer type
fn to_integer(&self) -> Option<i64>;
}
impl ToInteger for Resp2Frame {
fn to_integer(&self) -> Option<i64> {
match self {
Resp2Frame::Integer(number) => Some(*number),
_ => None,
}
}
}
impl ToInteger for Resp3Frame {
fn to_integer(&self) -> Option<i64> {
match self {
Resp3Frame::Number { data, attributes: _ } => Some(*data),
_ => None,
}
}
}
/// Trait for string extraction of RESP2/3 frames
pub trait ToStringBytes {
/// Extracts Bytes of Bulk (RESP2) or BLOB (RESP3) frames
/// None if frame was not Bulk/BLOB string
fn to_string_bytes(&self) -> Option<Bytes>;
}
impl ToStringBytes for Resp2Frame {
fn to_string_bytes(&self) -> Option<Bytes> {
match self {
Resp2Frame::BulkString(data) => Some(data.clone()),
_ => None,
}
}
}
impl ToStringBytes for Resp3Frame {
fn to_string_bytes(&self) -> Option<Bytes> {
match self {
Resp3Frame::BlobString { data, attributes: _ } => Some(data.clone()),
_ => None,
}
}
}
/// Trait for converting RESP2 arrays or RESP3 maps
pub trait ToBytesMap {
/// Converts the frame to map
/// Returns None in case of protocol violation
fn to_map(&self) -> Option<BTreeMap<Bytes, Bytes>>;
}
impl ToBytesMap for Resp2Frame {
fn to_map(&self) -> Option<BTreeMap<Bytes, Bytes>> {
let mut map = BTreeMap::new();
match self {
Frame::Array(array) => {
for item in array.chunks(2) {
if item.len() < 2 {
return None;
}
let field = match &item[0] {
Frame::SimpleString(value) | Frame::BulkString(value) => value.clone(),
_ => return None,
};
let value = match &item[1] {
Frame::SimpleString(value) | Frame::BulkString(value) => value.clone(),
_ => return None,
};
map.insert(field, value);
}
}
_ => return None,
}
Some(map)
}
}
impl ToBytesMap for Resp3Frame {
fn to_map(&self) -> Option<BTreeMap<Bytes, Bytes>> {
let mut map = BTreeMap::new();
match self {
Resp3Frame::Map { data, attributes: _ } => {
for item in data {
let field = match item.0 {
Resp3Frame::BlobString { data, attributes: _ }
| Resp3Frame::SimpleString { data, attributes: _ } => data.clone(),
_ => return None,
};
let value = match item.1 {
Resp3Frame::BlobString { data, attributes: _ }
| Resp3Frame::SimpleString { data, attributes: _ } => data.clone(),
_ => return None,
};
map.insert(field, value);
}
}
_ => return None,
}
Some(map)
}
}