Struct rsmq_async::Rsmq

pub struct Rsmq { /* fields omitted */ }

Implementations

impl Rsmq

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

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.

Trait Implementations

impl Debug for Rsmq

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

Formats the value using the given formatter.

impl RsmqConnection for Rsmq

pub fn change_message_visibility<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    qname: &'life1 str,
    message_id: &'life2 str,
    seconds_hidden: u64
) -> Pin<Box<dyn Future<Output = RsmqResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Change the hidden time of a already sent message.

pub fn create_queue<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    qname: &'life1 str,
    seconds_hidden: Option<u32>,
    delay: Option<u32>,
    maxsize: Option<i32>
) -> Pin<Box<dyn Future<Output = RsmqResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

pub fn delete_message<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    qname: &'life1 str,
    id: &'life2 str
) -> Pin<Box<dyn Future<Output = RsmqResult<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Deletes a message from the queue.

pub fn delete_queue<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    qname: &'life1 str
) -> Pin<Box<dyn Future<Output = RsmqResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Deletes the queue and all the messages on it

pub fn get_queue_attributes<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    qname: &'life1 str
) -> Pin<Box<dyn Future<Output = RsmqResult<RsmqQueueAttributes>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns the queue attributes and statistics

pub fn list_queues<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = RsmqResult<Vec<String>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a list of queues in the namespace

pub fn pop_message<'life0, 'life1, 'async_trait, E: TryFrom<RedisBytes, Error = Vec<u8>>>(
    &'life0 mut self,
    qname: &'life1 str
) -> Pin<Box<dyn Future<Output = RsmqResult<Option<RsmqMessage<E>>>> + Send + 'async_trait>> where
    E: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

pub fn receive_message<'life0, 'life1, 'async_trait, E: TryFrom<RedisBytes, Error = Vec<u8>>>(
    &'life0 mut self,
    qname: &'life1 str,
    seconds_hidden: Option<u64>
) -> Pin<Box<dyn Future<Output = RsmqResult<Option<RsmqMessage<E>>>> + Send + 'async_trait>> where
    E: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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 fn send_message<'life0, 'life1, 'async_trait, E: Into<RedisBytes> + Send>(
    &'life0 mut self,
    qname: &'life1 str,
    message: E,
    delay: Option<u64>
) -> Pin<Box<dyn Future<Output = RsmqResult<String>> + Send + 'async_trait>> where
    E: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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 fn set_queue_attributes<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    qname: &'life1 str,
    seconds_hidden: Option<u64>,
    delay: Option<u64>,
    maxsize: Option<i64>
) -> Pin<Box<dyn Future<Output = RsmqResult<RsmqQueueAttributes>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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"