Crate rsmq_async[][src]

Expand description

RSMQ in async Rust

RSMQ port to async rust. RSMQ is a simple redis queue system that works in any redis v2.6+. It contains the same methods as the original one in

This crate uses async in the implementation. If you want to use it in your sync code you can use tokio/async_std “block_on” method. Async was used in order to simplify the code and allow 1-to-1 port oft he JS code. dependency status Docs


use rsmq_async::{Rsmq, RsmqError, RsmqConnection};

let mut rsmq = Rsmq::new(Default::default()).await?;

let message = rsmq.receive_message::<String>("myqueue", None).await?;

if let Some(message) = message {
    rsmq.delete_message("myqueue", &;

Main object documentation are in: Rsmq and PooledRsmq and they both implement the trait RsmqConnection where you can see all the RSMQ methods. Make sure you always import the trait RsmqConnection.




use rsmq_async::{Rsmq, RsmqConnection};

async fn it_works() {
    let mut rsmq = Rsmq::new(Default::default())
        .expect("connection failed");

    rsmq.create_queue("myqueue", None, None, None)
        .expect("failed to create queue");

    rsmq.send_message("myqueue", "testmessage", None)
        .expect("failed to send message");

    let message = rsmq
        .receive_message::<String>("myqueue", None)
        .expect("cannot receive message");

    if let Some(message) = message {
        rsmq.delete_message("myqueue", &;


When initializing RSMQ you can enable the realtime PUBLISH for new messages. On every new message that gets sent to RSQM via sendMessage a Redis PUBLISH will be issued to {rsmq.ns}:rt:{qname}. So, you can subscribe to it using redis-rs library directly.

How to use the realtime option

Besides the PUBLISH when a new message is sent to RSMQ nothing else will happen. Your app could use the Redis SUBSCRIBE command to be notified of new messages and issue a receiveMessage then. However make sure not to listen with multiple workers for new messages with SUBSCRIBE to prevent multiple simultaneous receiveMessage calls.


If you want to implement “at least one delivery” guarantee, you need to receive the messages using “receive_message” and then, once the message is successfully processed, delete it with “delete_message”.

Connection Pool

If you want to use a connection pool, just use PooledRsmq instad of Rsmq. It implements the RsmqConnection trait as the normal Rsmq.

If you want to accept any of both implementation, just accept the trait RsmqConnection

Executor compatibility

Since version 0.16 where this pull request was merged redis-rs dependency supports tokio and async_std executors. By default it will guess what you are using when creating the connection. You can check redis-rs Cargo.tolm for the flags async-std-comp and tokio-comp in order to choose one or the other. If you don’t select any it should be able to automatically choose the correct one.

Response types

There are 3 functions that take generic types:

  • pop_message and receive_message: Where the type for the received message is RsmqMessage<E> where E: TryFrom<RedisBytes, Error = Vec<u8>>. So, If you have custom type, you can implement the trait TryFrom<RedisBytes> for YourCustomType and use it like: rsmq.receive_message::<YourCustomType>("myqueue", None). Implementations are provided for String and Vec<u8>.
  • send_message where the message to send needs to implement Into<RedisBytes> + Send. So you will need to implement the trait for your type. You can check the implementations for the type RedisBytes and see how we did it. Implementations are provided for String, &str and Vec<u8>.

All this is because strings in Rust are very convenient to use for json messages, so always returning a Vec may not be the most ergonomic solution. But at the same time, we can just add some already made implementations for it and you can just use it with your type or, if you are sending, let’s say, images, just use the method like: rsmq.receive_message::<Vec<u8>>("myqueue", None) and transform it later to your type. (Or just implement the TryFrom for your type and the transformation will be automatic.)

Example for implementing a custom type

impl TryFrom<RedisBytes> for String {

    // We sacrifice the ability of recovering the original error for the ability of having the
    // original data. If you know how to conserver both, let me know!
    type Error = Vec<u8>; // Always set Error as Vec<u8>;

    fn try_from(bytes: RedisBytes) -> Result<Self, Self::Error> {
        String::from_utf8(bytes.0).map_err(|e| e.into_bytes())


Internal value representing the redis bytes. It implements TryFrom String and Vec and From String, &str, Vec and &u8 to itself.

A new RSMQ message. You will get this when using pop_message or receive_message methods

Options for creating a new RSMQ instance.

Struct defining a queue. They are set on “create_queue” and “set_queue_attributes”


This is the error type for any oprtation with this library. It derives ThisError


Type Definitions

This is an alias of Result<T, RsmqError> for simplicity