Add Keys command #4

Author: fafhrd91

CHANGES.md

@@ -1,6 +1,8 @@
 # Changes
 
-## [0.3.2] - 2022-05-xx
+## [0.3.2] - 2022-05-04
+
+* Add `Keys` command #4
 
 * Add Clone trait impl to CommandError
 

src/cmd/keys.rs

@@ -1,6 +1,9 @@
+use std::convert::{TryFrom, TryInto};
+
+use ntex::util::ByteString;
+
 use super::{utils, Command, CommandError};
 use crate::codec::{BulkString, Request, Response};
-use std::convert::TryFrom;
 
 /// DEL redis command
 ///
@@ -183,3 +186,57 @@ impl Command for TtlCommand {
         })
     }
 }
+
+/// 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)),
+        }
+    }
+}

src/cmd/mod.rs

@@ -15,7 +15,7 @@ mod utils;
 pub use self::auth::Auth;
 pub use self::connection::{Ping, Select};
 pub use self::hashes::{HDel, HGet, HGetAll, HIncrBy, HLen, HSet};
-pub use self::keys::{Del, Exists, Expire, ExpireAt, Ttl, TtlResult};
+pub use self::keys::{Del, Exists, Expire, ExpireAt, Keys, Ttl, TtlResult};
 pub use self::lists::{LIndex, LPop, LPush, RPop, RPush};
 pub use self::strings::{Get, IncrBy, Set};
 
@@ -35,7 +35,7 @@ pub mod commands {
     //! Command implementations
     pub use super::auth::AuthCommand;
     pub use super::hashes::{HDelCommand, HGetAllCommand, HSetCommand};
-    pub use super::keys::{KeysCommand, TtlCommand};
+    pub use super::keys::{KeysCommand, KeysPatternCommand, TtlCommand};
     pub use super::lists::LPushCommand;
     pub use super::strings::SetCommand;
     pub use super::utils::{BulkOutputCommand, IntOutputCommand};

src/errors.rs

@@ -44,13 +44,15 @@ impl From<Either<Error, io::Error>> for Error {
     }
 }
 
-#[derive(Debug, Display, From)]
+#[derive(Debug, Display, From, Clone)]
 /// Redis connectivity errors
 pub enum ConnectError {
     /// Auth command failed
     Unauthorized,
+
     /// Command execution error
     Command(CommandError),
+
     /// Io connectivity error
     Connect(connect::ConnectError),
 }