Upgrade code for version 1.0

Author: daniel7grant

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "redis-macros"
 description = "Simple macros and wrappers to redis-rs to automatically serialize and deserialize structs with serde."
-version = "0.5.6"
+version = "1.0.0-rc.0"
 edition = "2021"
 authors = ["Daniel Grant"]
 readme = "README.md"
@@ -11,8 +11,8 @@ license = "MIT"
 keywords = ["redis", "macro", "derive", "json"]
 
 [dependencies]
-redis = { version = "0.32.0", optional = true }
-redis-macros-derive = { version = "0.5", optional = true, path = "./redis-macros-derive" }
+redis = { version = "1.0.0-rc", optional = true }
+redis-macros-derive = { version = "1.0.0-rc", optional = true, path = "./redis-macros-derive" }
 serde = { version = "1.0", features = ["derive"], optional = true }
 serde_json = { version = "1.0", optional = true }
 
@@ -23,6 +23,7 @@ macros = ["dep:redis-macros-derive"]
 
 [dev-dependencies]
 deadpool-redis = "0.22"
-redis = { version = "0.32.0", features = ["tokio-comp", "json"] }
+redis = { version = "1.0.0-rc", features = ["tokio-comp", "json"] }
 serde_yaml = "0.9"
 tokio = { version = "1.41", features = ["full"] }
+

Cargo.toml

@@ -2,9 +2,16 @@
 
 ## [Unreleased]
 
+## [1.0.0-rc.0]
+
 ### Updated
 
-- Update dependencies
+- **Breaking change**: Update Redis version to 1.0.0-rc.0
+    - This library mostly can be used without any changes, but read the [redis-rs breaking changes](https://github.com/redis-rs/redis-rs/blob/redis-1.0.0-rc.0/version1.md)
+    - Implement `ToSingleRedisArg` for types deriving the `ToSingleRedis` macro (see [ToSingleRedisArg trait](https://github.com/redis-rs/redis-rs/blob/redis-1.0.0-rc.0/version1.md#tosingleredisarg-trait-breaking-change))
+    - Change `FromRedisValue` to accept owned types (see [More efficient deserialization](https://github.com/redis-rs/redis-rs/blob/redis-1.0.0-rc.0/version1.md#more-efficient-deserialization-breaking-change))
+    - Change `FromRedisValue` error from `RedisError` to `ParsingError` ([Better error messages](https://github.com/redis-rs/redis-rs/blob/redis-1.0.0-rc.0/version1.md#better-error-messages-potentially-breaking))
+- Update other dependencies
 
 ## [0.5.6] - 2025-07-20
 

Changelog.md

@@ -8,8 +8,8 @@ To install it, simply add the package `redis-macros`. This package is a helper f
 
 ```toml
 [dependencies]
-redis-macros = "0.5"
-redis = { version = "0.29" }
+redis-macros = "1.0.0-rc"
+redis = { version = "1.0.0-rc" }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0" }
 ```

README.md

@@ -1,61 +1,63 @@
-use deadpool_redis::{
-    // Very important to import inner redis - otherwise macro expansion fails!
-    redis,
-    redis::{AsyncCommands, ErrorKind, RedisError, RedisResult},
-    Config,
-    Runtime,
-};
-use redis_macros::{FromRedisValue, ToRedisArgs};
-use serde::{Deserialize, Serialize};
+// TODO: COMMENTED OUT UNTIL DEADPOOL REDIS CATCHES UP WITH REDIS 1.0
+// use deadpool_redis::{
+//     // Very important to import inner redis - otherwise macro expansion fails!
+//     redis,
+//     redis::{AsyncCommands, ErrorKind, RedisError, RedisResult},
+//     Config,
+//     Runtime,
+// };
+// use redis_macros::{FromRedisValue, ToRedisArgs};
+// use serde::{Deserialize, Serialize};
+use redis::RedisResult;
 
-/// Define structs to hold the data
-/// Children structs don't have to implement FromRedisValue, ToRedisArgs, unless you want to use them as top level
-/// They have to implement serde traits though!
-#[derive(Debug, PartialEq, Serialize, Deserialize)]
-enum Address {
-    Street(String),
-    Road(String),
-}
+// /// Define structs to hold the data
+// /// Children structs don't have to implement FromRedisValue, ToRedisArgs, unless you want to use them as top level
+// /// They have to implement serde traits though!
+// #[derive(Debug, PartialEq, Serialize, Deserialize)]
+// enum Address {
+//     Street(String),
+//     Road(String),
+// }
 
-/// Don't forget to implement serde traits and redis traits!
-#[derive(Debug, PartialEq, Serialize, Deserialize, FromRedisValue, ToRedisArgs)]
-struct User {
-    id: u32,
-    name: String,
-    addresses: Vec<Address>,
-}
+// /// Don't forget to implement serde traits and redis traits!
+// #[derive(Debug, PartialEq, Serialize, Deserialize, FromRedisValue, ToRedisArgs)]
+// struct User {
+//     id: u32,
+//     name: String,
+//     addresses: Vec<Address>,
+// }
 
 /// Show a simple async usage of redis_macros traits
 /// Just derive the traits and forget them!
 #[tokio::main]
 async fn main() -> RedisResult<()> {
-    // Open new async connection to localhost
-    let cfg = Config::from_url("redis://localhost:6379");
+    // // Open new async connection to localhost
+    // let cfg = Config::from_url("redis://localhost:6379");
 
-    let pool = cfg.create_pool(Some(Runtime::Tokio1)).unwrap();
-    let mut con = pool.get().await.map_err(|_| {
-        RedisError::from((
-            ErrorKind::InvalidClientConfig,
-            "Cannot connect to localhost:6379. Try starting a redis-server process or container.",
-        ))
-    })?;
+    // let pool = cfg.create_pool(Some(Runtime::Tokio1)).unwrap();
+    // let mut con = pool.get().await.map_err(|_| {
+    //     RedisError::from((
+    //         ErrorKind::InvalidClientConfig,
+    //         "Cannot connect to localhost:6379. Try starting a redis-server process or container.",
+    //     ))
+    // })?;
 
-    // Define the data you want to store in Redis.
-    let user = User {
-        id: 1,
-        name: "Ziggy".to_string(),
-        addresses: vec![
-            Address::Street("Downing".to_string()),
-            Address::Road("Abbey".to_string()),
-        ],
-    };
+    // // Define the data you want to store in Redis.
+    // let user = User {
+    //     id: 1,
+    //     name: "Ziggy".to_string(),
+    //     addresses: vec![
+    //         Address::Street("Downing".to_string()),
+    //         Address::Road("Abbey".to_string()),
+    //     ],
+    // };
 
-    // Set and get back the user in Redis asynchronously, no problem
-    let _: () = con.set("user_deadpool", &user).await?;
-    let stored_user: User = con.get("user_deadpool").await?;
+    // // Set and get back the user in Redis asynchronously, no problem
+    // let _: () = con.set("user_deadpool", &user).await?;
+    // let stored_user: User = con.get("user_deadpool").await?;
 
-    // You will get back the same data
-    assert_eq!(user, stored_user);
+    // // You will get back the same data
+    // assert_eq!(user, stored_user);
 
     Ok(())
 }