Struct Rsmq

pub struct Rsmq { /* private fields */ }

Implementations

impl Rsmq

pub async fn new(options: RsmqOptions) -> RsmqResult<Rsmq>

Creates a new RSMQ instance, including its connection

pub async fn new_with_connection( connection: MultiplexedConnection, realtime: bool, ns: Option<&str>, ) -> RsmqResult<Rsmq>

Special method for when you already have a redis-rs connection and you don’t want redis_async to create a new one.

Trait Implementations

impl Clone for Rsmq

fn clone(&self) -> Rsmq

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rsmq

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl RsmqConnection for Rsmq

async fn change_message_visibility( &mut self, qname: &str, message_id: &str, hidden: Duration, ) -> RsmqResult<()>

Change the hidden time of a already sent message.

async fn create_queue( &mut self, qname: &str, hidden: Option<Duration>, delay: Option<Duration>, maxsize: Option<i32>, ) -> RsmqResult<()>

Creates a new queue. Attributes can be later modified with “set_queue_attributes” method

async fn delete_message(&mut self, qname: &str, id: &str) -> RsmqResult<bool>

Deletes a message from the queue.

async fn delete_queue(&mut self, qname: &str) -> RsmqResult<()>

Deletes the queue and all the messages on it

async fn get_queue_attributes( &mut self, qname: &str, ) -> RsmqResult<RsmqQueueAttributes>

Returns the queue attributes and statistics

async fn list_queues(&mut self) -> RsmqResult<Vec<String>>

Returns a list of queues in the namespace

async fn pop_message<E: TryFrom<RedisBytes, Error = Vec<u8>>>( &mut self, qname: &str, ) -> RsmqResult<Option<RsmqMessage<E>>>

Deletes and returns a message. Be aware that using this you may end with deleted & unprocessed messages.

async fn receive_message<E: TryFrom<RedisBytes, Error = Vec<u8>>>( &mut self, qname: &str, hidden: Option<Duration>, ) -> RsmqResult<Option<RsmqMessage<E>>>

Returns a message. The message stays hidden for some time (defined by “hidden” argument or the queue settings). After that time, the message will be redelivered. In order to avoid the redelivery, you need to use the “delete_message” after this function.

async fn send_message<E: Into<RedisBytes> + Send>( &mut self, qname: &str, message: E, delay: Option<Duration>, ) -> RsmqResult<String>

Sends a message to the queue. The message will be delayed some time (controlled by the “delayed” argument or the queue settings) before being delivered to a client.

async fn set_queue_attributes( &mut self, qname: &str, hidden: Option<Duration>, delay: Option<Duration>, maxsize: Option<i64>, ) -> RsmqResult<RsmqQueueAttributes>

Modify the queue attributes. Keep in mind that “hidden” and “delay” can be overwritten when the message is sent. “hidden” can be changed by the method “change_message_visibility”