Struct rsmq_async::Rsmq

pub struct Rsmq { /* fields omitted */ }

THe main object of this library. Creates/Handles the redis connection and contains all the methods

Methods

impl Rsmq

pub async fn new(options: RsmqOptions) -> Result<Rsmq, RsmqError>

Creates a new RSMQ instance, including its connection

pub fn new_with_connection(options: RsmqOptions, connection: Connection) -> Rsmq

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

pub async fn change_message_visibility<'_, '_, '_>(
    &'_ mut self,
    qname: &'_ str,
    message_id: &'_ str,
    seconds_hidden: u64
) -> Result<(), RsmqError>

Change the hidden time of a already sent message.

pub async fn create_queue<'_, '_>(
    &'_ mut self,
    qname: &'_ str,
    seconds_hidden: Option<u32>,
    delay: Option<u32>,
    maxsize: Option<i32>
) -> Result<(), RsmqError>

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

seconds_hidden: Time the messages will be hidden when they are received with the "receive_message" method.

delay: Time the messages will be delayed before being delivered

maxsize: Maximum size in bytes of each message in the queue. Needs to be between 1024 or 65536 or -1 (unlimited size)

pub async fn delete_message<'_, '_, '_>(
    &'_ mut self,
    qname: &'_ str,
    id: &'_ str
) -> Result<bool, RsmqError>

Deletes a message from the queue.

Important to use when you are using receive_message.

pub async fn delete_queue<'_, '_>(
    &'_ mut self,
    qname: &'_ str
) -> Result<(), RsmqError>

Deletes the queue and all the messages on it

pub async fn get_queue_attributes<'_, '_>(
    &'_ mut self,
    qname: &'_ str
) -> Result<RsmqQueueAttributes, RsmqError>

Returns the queue attributes and statistics

pub async fn list_queues<'_>(&'_ mut self) -> Result<Vec<String>, RsmqError>

Returns a list of queues in the namespace

pub async fn pop_message<'_, '_>(
    &'_ mut self,
    qname: &'_ str
) -> Result<Option<RsmqMessage>, RsmqError>

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

pub async fn receive_message<'_, '_>(
    &'_ mut self,
    qname: &'_ str,
    seconds_hidden: Option<u64>
) -> Result<Option<RsmqMessage>, RsmqError>

Returns a message. The message stays hidden for some time (defined by "seconds_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 "dekete_message" after this function.

pub async fn send_message<'_, '_, '_>(
    &'_ mut self,
    qname: &'_ str,
    message: &'_ str,
    delay: Option<u64>
) -> Result<String, RsmqError>

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.

pub async fn set_queue_attributes<'_, '_>(
    &'_ mut self,
    qname: &'_ str,
    seconds_hidden: Option<u64>,
    delay: Option<u64>,
    maxsize: Option<i64>
) -> Result<RsmqQueueAttributes, RsmqError>

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

seconds_hidden: Time the messages will be hidden when they are received with the "receive_message" method.

delay: Time the messages will be delayed before being delivered

maxsize: Maximum size in bytes of each message in the queue. Needs to be between 1024 or 65536 or -1 (unlimited size)

Trait Implementations

impl Debug for Rsmq

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

Formats the value using the given formatter.