redis-raw-rs is a minimal Redis client library implementation. It exposes a general purpose interface to Redis.
The crate is called redis_raw
and you can depend on it via cargo:
[dependencies]
redis_raw = "*"
If you want to use the git version:
[dependencies]
redis_raw = { version = "*", git = "git@github.com:aminroosta/redis-raw-rs.git" }
Basic Operation
redis_raw
exposes two API levels: a low- and a lower-level part!
The low-level
part does not expose all the functionality of redis and
might take some liberties in how it speaks the protocol. The lower-level
part of the API allows you to express any request on the redis level.
You can fluently switch between both API levels at any point.
Connection Handling
For connecting to redis you can use tokio::net::TcpStream
which can be
converted to (or from) RedisConnection
.
use RedisConnection;
use TcpStream;
async
#
Executing Lower-Level Commands
To execute lower-level commands you can use the write()
and read()
functions
which allow you to make redis requests and parse redis (RESP) responses.
These functions correspond to the underlying socket's read and write operations.
The read()
function parses the RESP response as redis_raw::Value
.
Value
Represents a redis RESP protcol response.
use
Executing Low-Level Commands
The low-level interface is similar. The command()
function does a
write()
and a read()
and converts the Value
into requested type.
use
Here is another example, to find out the correct result type see redis docs.
use
The following return types are supported:
()
, i64
, String
, Vec<i64>
, and Vec<String>