darkredis
is a Redis client for Rust written using the new std::future
and async_await
. It's designed to be easy to use, and lacks advanced features. Requires rust 1.39.0 or newer.
Currently not all Redis commands have convenience functions, and there may be ergonomic improvements to make.
As of version 0.8.0, darkredis is no longer maintained.
When darkredis
was originally written, it was part of an async project. At the time, there was no real way to use .await
with redis-rs, so I set out to change that. The result is darkredis
, and it has worked very well for my own personal use, which it might for you too. It's designed to be as simple as possible, serving as an easy way to call redis commands.
runtime_tokio
(on by default): Use the tokio 0.2 runtime and Tcp primitives. Requires a running tokio 0.2 runtime.runtime_async_std
: Useasync-std
instead of tokio, using it's runtime instead of tokio. Is mutually exclusive with theruntime_tokio
feature.
- Add
darkredis
and to yourCargo.toml
. - Create an async context somehow, for instance by using
tokio
0.2. - Create a
ConnectionPool
and grab a connection!
use darkredis::ConnectionPool;
#[tokio::main]
async fn main() -> darkredis::Result<()> {
let pool = ConnectionPool::create("127.0.0.1:6379".into(), None, num_cpus::get()).await?;
let mut conn = pool.get().await;
//And away!
conn.set("secret_entrance", b"behind the bookshelf").await?;
let secret_entrance = conn.get("secret_entrance").await?;
assert_eq!(secret_entrance, Some("behind the bookshelf".into()));
//Keep our secrets
conn.del("secret_entrance").await?;
Ok(())
}
- Update tokio to 1.0
- Update dependencies
- Move away from futures mutexes to async-std/tokio mutexes.
This is likely to be the last release. Don't expect any updates.
- Change the blpop and brpop commands to return a tuple instead an unnecesarry vector.
- Added new error variant: EmptySlice
del
,sadd
now returnbool
.
- Properly parse nested arrays.
- Convenience functions now return an error if a given slice is empty.
- Add support for SCAN, SSCAN and HSCAN.
- Convenience function for the TYPE command.
- Add convenience functions for all set commands.
- Change
run_commands
to return a stream. - Rename
runtime_agnostic
feature toruntime_async_std
- Split
Connection::connect
into one which authenticates and one which doesn't. - Connection password now takes
AsRef<[u8]>
instead of forcing a string. - Remove deprecated function
set_with_expiry
- Change
MSET
to use the newMSetBuilder
struct
- Hashmap convenience functions
- Add some convenience functions for sets
- Allow running commands using a pre-allocated serialization buffer
- Most types now implement
Debug
- Improve serialization performance by 50%! 🎉
- Add benchmarks
- Add blpop and brpop
- Update to tokio 0.2.3 and async-std 1.2.0
- Add expiry commands
- Connection: deprecate
set_with_expiry
, useset_and_expire_seconds
andset_and_expire_ms
instead.
- Updated to async-std 1.0.1 and futures 0.3.1
- (BREAKING) Add the
runtime_agnostic
andruntime_tokio
features. - Simple Pubsub support using the
MessageStream
andPMessageStream
types. - Ability to spawn a new connection using the settings from a ConnectionPool
- Use
tokio
in test mode. - Add convenience function for
PUBLISH
- Add pubsub example
- Add variants of builder functions for
Command
andCommandList
which mutate the object instead of moving it.
- Expclicitly use traits from
async-std
, notstd
. This fixes compilation on async-std 0.99.5
- Add convenience functions for the
INCR
andDECR
family of commands, as well as forAPPEND
,MGET
,MSET
,EXISTS
. - Improve the documentation of convenience functions
- Allow renaming of client connections in connection pools
- Use
async-std
instead ofruntime
for TcpStream, allowing using darkredis with any runtime.
- Update dependencies
- Fix compilation error on latest nightly
- Command and CommandList no longer perform any copies
- Added args method to Command and CommandList
lpush
andrpush
now take multiple arguments- Support password auth
lrange
no longer returns an Option, returns an empty vec instead.- Add convenience functions for the following commands:
lset
,ltrim
- Remove unnecesarry generic parameter from lpop and rpop methods.
- Fix a couple documentation errors
- Initial release
If you're hacking on darkredis
and want to run the tests, make sure you have a Redis instance running on your local machine on port 6379. The tests clean up any keys set by themselves, unless the test fails. Please submit an issue if it does not.
Also, make sure to run the tests using both the runtime_tokio
and runtime_async_std
features, to make sure that it works.