Structs and functions for implementing the Redis protocol.
With cargo edit.
cargo add redis-protocol
- Supports RESP2 and RESP3, including streaming frames.
- Encode and decode with
BytesMut
or slices. - Parse publish-subscribe messages.
- Support cluster redirection errors.
- Implements cluster key hashing.
- Utility functions for converting between RESP2 and RESP3.
use redis_protocol::resp2::prelude::*;
use bytes::BytesMut;
fn main() {
let frame = Frame::BulkString("foobar".into());
let mut buf = BytesMut::new();
let len = match encode_bytes(&mut buf, &frame) {
Ok(l) => l,
Err(e) => panic!("Error encoding frame: {:?}", e)
};
println!("Encoded {} bytes into buffer with contents {:?}", len, buf);
let buf: BytesMut = "*3\r\n$3\r\nFoo\r\n$-1\r\n$3\r\nBar\r\n".into();
let (frame, consumed) = match decode(&buf) {
Ok(Some((f, c))) => (f, c),
Ok(None) => panic!("Incomplete frame."),
Err(e) => panic!("Error parsing bytes: {:?}", e)
};
println!("Parsed frame {:?} and consumed {} bytes", frame, consumed);
let key = "foobarbaz";
println!("Hash slot for {}: {}", key, redis_keyslot(key));
}
Enable the index-map
feature to use IndexMap instead of HashMap
and HashSet
. This is useful for testing and may also be useful to callers.
To run the unit tests:
cargo test --features index-map