embedded-redis 0.4.0

A no_std Redis client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# Redis Client for no_std
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Crates.io](https://img.shields.io/crates/v/embedded-redis.svg)](https://crates.io/crates/embedded-redis)
[![Actions Status](https://github.com/pegasus-aero/rt-embedded-redis/workflows/QA/badge.svg)](http://github.com/pegasus-aero/rt-embedded-redis/actions)

This crate offers a non-blocking Redis Client for no_std targets.
Both RESP2 and RESP3 protocol are supported.

## Documentation:
* [Connection management](https://docs.rs/embedded-redis/latest/embedded_redis/network/index.html#connection-handling)
* [Non-blocking response handling](https://docs.rs/embedded-redis/latest/embedded_redis/network/index.html#non-blocking-response-management)
* Popular command examples:
  * [SET command](https://docs.rs/embedded-redis/latest/embedded_redis/commands/set/index.html)
  * [GET command](https://docs.rs/embedded-redis/latest/embedded_redis/commands/get/index.html)
  * [PUBLISH command](https://docs.rs/embedded-redis/latest/embedded_redis/commands/publish/index.html)
* [Command abstraction](https://docs.rs/embedded-redis/latest/embedded_redis/commands/index.html)
* [Custom commands](https://docs.rs/embedded-redis/latest/embedded_redis/commands/custom/index.html)
* [Subscriptions](https://docs.rs/embedded-redis/latest/embedded_redis/subscribe)

## Example
```rust
use core::str::FromStr;
use embedded_nal::SocketAddr;
use std_embedded_nal::Stack;
use std_embedded_time::StandardClock;
use embedded_redis::network::ConnectionHandler;

let mut stack = Stack::default();
let clock = StandardClock::default();

let server_address = SocketAddr::from_str("127.0.0.1:6379").unwrap();
let mut connection_handler = ConnectionHandler::resp2(server_address);
let client = connection_handler.connect(&mut stack, Some(&clock)).unwrap();

let future = client.set("key", "value").unwrap();
let response = future.wait().unwrap();
```

## Development

Any form of support is greatly appreciated. Feel free to create issues and PRs.
See [DEVELOPMENT](DEVELOPMENT.md) for more details.  

## Benchmarks

The following command can be used to run the benchmarks.

*A local Redis instance is required.*

````
cargo bench --features benchmarks
````

| System          | Async publish   | Sync publish   |
|-----------------|-----------------|----------------|
| Desktop *¹      | 291,800 msg / s | 70,025 msg / s |
| Raspberry 4B *¹ | 59,744  msg / s | 10,641 msg / s |

**¹ Rust 1.67.0-nightly, AMD Ryzen 9, DDR4, Ubuntu 22.02, Redis v6.0.16*

**¹ Rust 1.67.0-nightly, Raspberry Pi OS 10, Redis v7.0.5*

## License
Licensed under either of

* Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.

Each contributor agrees that his/her contribution covers both licenses.