23 releases

0.10.0 Feb 19, 2019
0.9.1 Sep 10, 2018
0.9.0 Aug 8, 2018
0.8.0 Dec 26, 2016
0.0.2 Nov 23, 2014

#7 in Database interfaces

Download history 1520/week @ 2018-11-08 1263/week @ 2018-11-15 1456/week @ 2018-11-22 1706/week @ 2018-11-29 1898/week @ 2018-12-06 1870/week @ 2018-12-13 1128/week @ 2018-12-20 639/week @ 2018-12-27 1470/week @ 2019-01-03 1678/week @ 2019-01-10 1711/week @ 2019-01-17 1693/week @ 2019-01-24 2017/week @ 2019-01-31 1549/week @ 2019-02-07 2007/week @ 2019-02-14

6,896 downloads per month
Used in 58 crates (55 directly)

BSD-3-Clause

173KB
3K SLoC

redis-rs

Build Status crates.io

Redis-rs is a high level redis library for Rust. It provides convenient access to all Redis functionality through a very flexible but low-level API. It uses a customizable type conversion trait so that any operation can return results in just the type you are expecting. This makes for a very pleasant development experience.

The crate is called redis and you can depend on it via cargo:

[dependencies]
redis = "0.9.0"

Documentation on the library can be found at docs.rs/redis.

Note: redis-rs requires at least Rust 1.26.

Basic Operation

To open a connection you need to create a client and then to fetch a connection from it. In the future there will be a connection pool for those, currently each connection is separate and not pooled.

Many commands are implemented through the Commands trait but manual command creation is also possible.

extern crate redis;
use redis::Commands;

fn fetch_an_integer() -> redis::RedisResult<isize> {
    // connect to redis
    let client = redis::Client::open("redis://127.0.0.1/")?;
    let con = client.get_connection()?;
    // throw away the result, just make sure it does not fail
    let _ : () = con.set("my_key", 42)?;
    // read back the key and return it.  Because the return value
    // from the function is a result for integer this will automatically
    // convert into one.
    con.get("my_key")
}

Development

If you want to develop on the library there are a few commands provided by the makefile:

To build:

$ make

To test:

$ make test

To run benchmarks:

$ make bench

To build the docs:

$ make docs

Dependencies

~5.5MB
~102K SLoC