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
use std::convert::{TryFrom, TryInto};
use ntex::util::ByteString;
use super::{utils, Command, CommandError};
use crate::codec::{BulkString, Request, Response};
/// DEL redis command
///
/// Removes the specified keys. A key is ignored if it does not exist.
///
/// ```rust
/// use ntex_redis::{cmd, RedisConnector};
/// # use rand::{thread_rng, Rng, distributions::Alphanumeric};
/// # fn gen_random_key() -> String {
/// # thread_rng().sample_iter(&Alphanumeric).take(12).map(char::from).collect::<String>()
/// # }
///
/// #[ntex::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let redis = RedisConnector::new("127.0.0.1:6379").connect().await?;
/// let key = gen_random_key();
///
/// // set string value
/// redis.exec(cmd::Set(&key, "value")).await?;
///
/// // remove keys
/// let value = redis.exec(
/// cmd::Del(&key).key("test_1").key("test_2")
/// ).await?;
///
/// assert_eq!(value, 1);
/// Ok(())
/// }
/// ```
pub fn Del<T>(key: T) -> KeysCommand
where
BulkString: From<T>,
{
KeysCommand(vec![
Request::from_static("DEL"),
Request::BulkString(key.into()),
])
}
/// EXISTS redis command
///
/// Returns if key exists.
///
/// ```rust
/// use ntex_redis::{cmd, RedisConnector};
/// # use rand::{thread_rng, Rng, distributions::Alphanumeric};
/// # fn gen_random_key() -> String {
/// # thread_rng().sample_iter(&Alphanumeric).take(12).map(char::from).collect::<String>()
/// # }
///
/// #[ntex::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let redis = RedisConnector::new("127.0.0.1:6379").connect().await?;
/// let key = gen_random_key();
///
/// // set string value
/// redis.exec(cmd::Set(&key, "value")).await?;
///
/// // check keys existence
/// let value = redis.exec(
/// cmd::Exists(&key).keys(vec!["test_1", "test_2"])
/// ).await?;
///
/// assert_eq!(value, 1);
/// Ok(())
/// }
/// ```
pub fn Exists<T>(key: T) -> KeysCommand
where
BulkString: From<T>,
{
KeysCommand(vec![
Request::from_static("EXISTS"),
Request::BulkString(key.into()),
])
}
pub struct KeysCommand(Vec<Request>);
impl KeysCommand {
/// Add a key to this command.
pub fn key<T>(mut self, other: T) -> Self
where
BulkString: From<T>,
{
self.0.push(other.into());
self
}
/// Add more keys to this command.
pub fn keys<T>(mut self, other: impl IntoIterator<Item = T>) -> Self
where
BulkString: From<T>,
{
self.0.extend(other.into_iter().map(|t| t.into()));
self
}
}
impl Command for KeysCommand {
type Output = usize;
fn to_request(self) -> Request {
Request::Array(self.0)
}
fn to_output(val: Response) -> Result<Self::Output, CommandError> {
match val {
Response::Integer(val) => Ok(val as usize),
_ => Err(CommandError::Output("Cannot parse response", val)),
}
}
}
/// EXPIRE redis command
///
/// Set a timeout on `key`.
pub fn Expire<T, S>(key: T, seconds: S) -> utils::BoolOutputCommand
where
BulkString: From<T>,
i64: From<S>,
{
utils::BoolOutputCommand(Request::Array(vec![
Request::from_static("EXPIRE"),
Request::BulkString(key.into()),
Request::BulkString(i64::from(seconds).to_string().into()),
]))
}
/// EXPIREAT redis command
///
/// Set a timeout on `key`.
pub fn ExpireAt<T, S>(key: T, timestamp: S) -> utils::BoolOutputCommand
where
BulkString: From<T>,
i64: From<S>,
{
utils::BoolOutputCommand(Request::Array(vec![
Request::from_static("EXPIREAT"),
Request::BulkString(key.into()),
Request::BulkString(i64::from(timestamp).to_string().into()),
]))
}
/// TTL redis command
///
/// Returns the remaining time to live of a `key` that has a timeout.
pub fn Ttl<T>(key: T) -> TtlCommand
where
BulkString: From<T>,
{
TtlCommand(vec![
Request::from_static("TTL"),
Request::BulkString(key.into()),
])
}
#[derive(Debug, PartialEq, Eq)]
pub enum TtlResult {
Seconds(i64),
NoExpire,
NotFound,
}
pub struct TtlCommand(Vec<Request>);
impl Command for TtlCommand {
type Output = TtlResult;
fn to_request(self) -> Request {
Request::Array(self.0)
}
fn to_output(val: Response) -> Result<Self::Output, CommandError> {
let result = i64::try_from(val)?;
Ok(match result {
-1 => TtlResult::NoExpire,
-2 => TtlResult::NotFound,
s => TtlResult::Seconds(s),
})
}
}
/// KEYS redis command
///
/// Returns all keys matching pattern.
///
/// ```rust
/// use ntex_redis::{cmd, RedisConnector};
/// # use rand::{thread_rng, Rng, distributions::Alphanumeric};
/// # fn gen_random_key() -> String {
/// # thread_rng().sample_iter(&Alphanumeric).take(12).map(char::from).collect::<String>()
/// # }
///
/// #[ntex::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let redis = RedisConnector::new("127.0.0.1:6379").connect().await?;
///
/// // set keys
/// redis.exec(cmd::Set("firstname", "Jack")).await?;
/// redis.exec(cmd::Set("lastname", "Stuntman")).await?;
///
/// // get keys
/// let mut keys = redis.exec(cmd::Keys("*name*")).await?;
/// # keys.sort();
///
/// assert_eq!(&keys[..], &["firstname", "lastname"][..]);
/// Ok(())
/// }
/// ```
pub fn Keys<T>(key: T) -> KeysPatternCommand
where
BulkString: From<T>,
{
KeysPatternCommand(Request::Array(vec![
Request::from_static("KEYS"),
Request::BulkString(key.into()),
]))
}
pub struct KeysPatternCommand(Request);
impl Command for KeysPatternCommand {
type Output = Vec<ByteString>;
fn to_request(self) -> Request {
self.0
}
fn to_output(val: Response) -> Result<Self::Output, CommandError> {
match val.try_into() {
Ok(val) => Ok(val),
Err((_, val)) => Err(CommandError::Output("Cannot parse response", val)),
}
}
}