Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dedztbh/serde-resp
Redis RESP protocol serialization and deserialization with serde
https://github.com/dedztbh/serde-resp
redis rust serde
Last synced: 3 months ago
JSON representation
Redis RESP protocol serialization and deserialization with serde
- Host: GitHub
- URL: https://github.com/dedztbh/serde-resp
- Owner: dedztbh
- License: mit
- Created: 2021-02-14T03:53:59.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-16T05:30:25.000Z (almost 4 years ago)
- Last Synced: 2024-10-02T05:01:32.941Z (4 months ago)
- Topics: redis, rust, serde
- Language: Rust
- Homepage:
- Size: 29.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# serde-RESP
Redis RESP protocol serialization and deserialization with serde.
[RESP Specification](https://redis.io/topics/protocol)
To use the crate, add this to your `Cargo.toml`:
```
[dependencies]
serde-resp = "0.3.1"
```
## Usage
**IMPORTANT: Do NOT (de)serialize with any other types besides `RESP/RESPType`! You may get panic or incorrect results!**
[Why?](#why-resptype-wrapper)
Here are the Redis RESP types and their corresponding Rust types for (de)serialize operations.
- `Simple String`
+ `RESP::SimpleString(String)`
- `Error`
+ `RESP::Error(String)`
- `Integer`
+ `RESP::Integer(i64)`
- `Bulk String`
+ `RESP::BulkString(Option>)`
+ Use `None` for null bulk strings and `Some` for non-null ones.
- `Array`
+ `RESP::Array(Option>)`
+ Use `None` for null arrays and `Some` for non-null ones.
To serialize, use [ser::to_string](https://docs.rs/serde_resp/0.3.1/serde_resp/ser/fn.to_string.html)
or [ser::to_writer](https://docs.rs/serde_resp/0.3.1/serde_resp/ser/fn.to_writer.html).
To deserialize, use [de::from_str](https://docs.rs/serde_resp/0.3.1/serde_resp/de/fn.from_str.html)
or [de::from_reader](https://docs.rs/serde_resp/0.3.1/serde_resp/de/fn.from_reader.html)
or [de::from_buf_reader](https://docs.rs/serde_resp/0.3.1/serde_resp/de/fn.from_buf_reader.html).
For usage examples, refer to https://docs.rs/serde_resp/0.3.1/serde_resp/enum.RESPType.html
## Macros
Since 0.3.0, you can start using very handy macros! Here is a demo:
```rust
use serde_resp::{array, array_null, bulk, bulk_null, de, err_str, int, ser, simple, RESP};
let resp_array = array![
simple!("simple string".to_owned()),
err_str!("error string".to_owned()),
int!(42),
bulk!(b"bulk string".to_vec()),
bulk_null!(),
array![
simple!("arrays of arrays!".to_owned()),
array![simple!("OK ENOUGH!".to_owned())],
],
array_null!(),
];
let serialized = ser::to_string(&resp_array).unwrap();
assert_eq!(
"*7\r\n+simple string\r\n-error string\r\n:42\r\n$11\r\nbulk string\r\n$-1\r\n*2\r\n+arrays of arrays!\r\n*1\r\n+OK ENOUGH!\r\n*-1\r\n",
serialized
);
let deserialized = de::from_str(&serialized).unwrap();
assert_eq!(resp_array, deserialized);
```
## Documentation
https://docs.rs/serde_resp/0.3.1/serde_resp
## Why RESPType Wrapper?
The RESP protocol does not fit the serde data model well.
- RESP has no structured types (besides array).
This means (de)serializing structured data like `struct`, `enum`, or `tuple` does not make sense.
- RESP has multiple string types (simple and error string).
So what should Rust `String` map to? Simple or error string? Using what serde offers here will introduce a lot of ambiguity.
Another problem is that serde assumes there is only one string type so I need to apply some "hacks" to make (de)serializer work correctly.
These "hacks" involve (de)serialize methods that users are not supposed to use.
- RESP has multiple null types (null bulk string and null array). Similar to above, a lot of ambiguity and "hacks".
A bonus reason is this makes it easier to define array, which can be recursive.
I know this is very strict and tedious to write. But less ambiguity is always a good thing.
Plus now with macros, it should be more pleasant to use now.