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
//! # Deadpool for Redis [![Latest Version](https://img.shields.io/crates/v/deadpool-redis.svg)](https://crates.io/crates/deadpool-redis) //! //! Deadpool is a dead simple async pool for connections and objects //! of any type. //! //! This crate implements a [`deadpool`](https://crates.io/crates/deadpool) //! manager for [`redis`](https://crates.io/crates/redis). //! //! ## Features //! //! | Feature | Description | Extra dependencies | Default | //! | ------- | ----------- | ------------------ | ------- | //! | `config` | Enable support for [config](https://crates.io/crates/config) crate | `config`, `serde/derive` | yes | //! | `rt_tokio_1` | Enable support for [tokio](https://crates.io/crates/tokio) crate | `deadpool/rt_tokio_1`, `redis/tokio-comp` | yes | //! | `rt_async-std_1` | Enable support for [async-std](https://crates.io/crates/config) crate | `deadpool/rt_async-std_1`, `redis/async-std-comp` | no | //! //! ## Example //! //! ```rust,ignore //! use deadpool_redis::redis::{cmd, Config, FromRedisValue}; //! //! #[tokio::main] //! async fn main() { //! let mut cfg = Config::default(); //! cfg.url = Some("redis://127.0.0.1/".to_string()); //! let pool = cfg.create_pool().unwrap(); //! { //! let mut conn = pool.get().await.unwrap(); //! cmd("SET") //! .arg(&["deadpool/test_key", "42"]) //! .query_async::<_, ()>(&mut conn) //! .await.unwrap(); //! } //! { //! let mut conn = pool.get().await.unwrap(); //! let value: String = cmd("GET") //! .arg(&["deadpool/test_key"]) //! .query_async(&mut conn) //! .await.unwrap(); //! assert_eq!(value, "42".to_string()); //! } //! } //! ``` //! //! ## Example with `config` and `dotenv` crate //! //! ```rust //! use deadpool_redis::redis::{cmd, FromRedisValue}; //! use dotenv::dotenv; //! use serde::Deserialize; //! //! #[derive(Debug, Deserialize)] //! struct Config { //! #[serde(default)] //! redis: deadpool_redis::Config //! } //! //! impl Config { //! pub fn from_env() -> Result<Self, ::config_crate::ConfigError> { //! let mut cfg = ::config_crate::Config::new(); //! cfg.merge(::config_crate::Environment::new().separator("__"))?; //! cfg.try_into() //! } //! } //! //! #[tokio::main] //! async fn main() { //! dotenv().ok(); //! let cfg = Config::from_env().unwrap(); //! let pool = cfg.redis.create_pool().unwrap(); //! { //! let mut conn = pool.get().await.unwrap(); //! cmd("SET") //! .arg(&["deadpool/test_key", "42"]) //! .query_async::<_, ()>(&mut conn) //! .await.unwrap(); //! } //! { //! let mut conn = pool.get().await.unwrap(); //! let value: String = cmd("GET") //! .arg(&["deadpool/test_key"]) //! .query_async(&mut conn) //! .await.unwrap(); //! assert_eq!(value, "42".to_string()); //! } //! } //! ``` //! //! ## FAQ //! //! - **How can I enable features of the `redis` crate?** //! //! Make sure that you depend on the same version of `redis` as //! `deadpool-redis` does and enable the needed features in your own //! `Crate.toml` file: //! //! ```toml //! [dependencies] //! deadpool-redis = { version = "0.8", features = ["config"] } //! redis = { version = "0.20", default-features = false, features = ["tls"] } //! ``` //! //! ## License //! //! Licensed under either of //! //! - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>) //! - MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>) //! //! at your option. #![warn(missing_docs, unreachable_pub)] use std::{ ops::{Deref, DerefMut}, sync::atomic::{AtomicUsize, Ordering}, }; use async_trait::async_trait; /// Re-export deadpool::managed::PoolConfig pub use deadpool::managed::PoolConfig; use deadpool::managed::RecycleError; /// Re-export deadpool::Runtime; pub use deadpool::Runtime; use redis::{ aio::{Connection as RedisConnection, ConnectionLike}, Client, IntoConnectionInfo, RedisError, RedisResult, }; /// A type alias for using `deadpool::Pool` with `redis` pub type Pool = deadpool::managed::Pool<Manager, ConnectionWrapper>; /// A type alias for using `deadpool::PoolError` with `redis` pub type PoolError = deadpool::managed::PoolError<RedisError>; /// A type alias for using `deadpool::Object` with `redis` pub type Connection = deadpool::managed::Object<Manager>; type RecycleResult = deadpool::managed::RecycleResult<RedisError>; /// Re-export redis crate pub use redis; mod config; pub use config::{Config, CreatePoolError}; /// A wrapper for `redis::Connection`. The `query_async` and `execute_async` /// functions of `redis::Cmd` and `redis::Pipeline` consume the connection. /// This wrapper makes it possible to replace the internal connection after /// executing a query. pub struct ConnectionWrapper { conn: Connection, } impl ConnectionWrapper { /// Take this object from the pool permanently. This reduces the size of /// the pool. pub fn take(this: Self) -> RedisConnection { Connection::take(this.conn) } } impl From<Connection> for ConnectionWrapper { fn from(conn: Connection) -> Self { Self { conn } } } impl Deref for ConnectionWrapper { type Target = RedisConnection; fn deref(&self) -> &RedisConnection { &self.conn } } impl DerefMut for ConnectionWrapper { fn deref_mut(&mut self) -> &mut RedisConnection { &mut self.conn } } impl AsRef<redis::aio::Connection> for ConnectionWrapper { fn as_ref(&self) -> &redis::aio::Connection { &self.conn } } impl AsMut<redis::aio::Connection> for ConnectionWrapper { fn as_mut(&mut self) -> &mut redis::aio::Connection { &mut self.conn } } impl ConnectionLike for ConnectionWrapper { fn req_packed_command<'a>( &'a mut self, cmd: &'a redis::Cmd, ) -> redis::RedisFuture<'a, redis::Value> { self.conn.req_packed_command(cmd) } fn req_packed_commands<'a>( &'a mut self, cmd: &'a redis::Pipeline, offset: usize, count: usize, ) -> redis::RedisFuture<'a, Vec<redis::Value>> { self.conn.req_packed_commands(cmd, offset, count) } fn get_db(&self) -> i64 { self.conn.get_db() } } /// The manager for creating and recyling lapin connections pub struct Manager { client: Client, ping_number: AtomicUsize, } impl Manager { /// Create manager using `PgConfig` and a `TlsConnector` pub fn new<T: IntoConnectionInfo>(params: T) -> RedisResult<Self> { Ok(Self { client: Client::open(params)?, ping_number: AtomicUsize::new(0), }) } } #[async_trait] impl deadpool::managed::Manager for Manager { type Type = RedisConnection; type Error = RedisError; async fn create(&self) -> Result<RedisConnection, RedisError> { let conn = self.client.get_async_connection().await?; Ok(conn) } async fn recycle(&self, conn: &mut RedisConnection) -> RecycleResult { let ping_number = self.ping_number.fetch_add(1, Ordering::Relaxed).to_string(); match redis::cmd(&format!("PING {}", ping_number)) .query_async::<_, String>(conn) .await { Ok(n) => { if n == ping_number { Ok(()) } else { Err(RecycleError::Message(String::from("Invalid PING response"))) } } Err(e) => Err(e.into()), } } }