Struct rabbit_mqr::Queue

pub struct Queue {
    pub name: String,
    pub channel: Channel,
    pub exchange: String,
    pub routing_key: String,
}

Represents a single Queue

Fields

name: String

channel: Channel

exchange: String

routing_key: String

Implementations

impl Queue

pub async fn new( name: &str, channel: Channel, options: Option<QueueDeclareOptions>, arguments: Option<FieldTable> ) -> Result<Self, Error>

Construct a Queue

Exchange is: "{name}_exchange"

Routing key is: "{name}_routing_key"

---

Example Usage:

let channel: Channel = ...;

let queue = Queue::new(
    "my_queue",
    channel,
    None,
    None,
).await?;

pub async fn purge(&self, no_wait: bool) -> Result<MessageCount, Error>

Purge the Queue, returns the amount of messages deleted.

---

Example Usage:

let queue: Queue = ...;

let deleted_count: MessageCount = queue.purge(false).await?;

pub async fn recover(&self, requeue: bool) -> Result<(), Error>

Recover the Queue.

---

Example Usage:

let queue: Queue = ...;

queue.recover(false).await?;

pub async fn delete( &self, options: Option<QueueDeleteOptions> ) -> Result<MessageCount, Error>

Delete the Queue, returns the amount of messages deleted.

---

Example Usage:

let queue: Queue = ...;

let deleted_count: MessageCount = queue.purge(None).await?;

pub async fn publish_message( &self, message: Vec<u8>, properties: Option<BasicProperties> ) -> Result<(), Error>

Publish a message to the Queue.

---

Example Usage:

let queue: Queue = ...;

let message = b"1337".to_vec();

queue.publish_message(message, None).await?;

pub async fn get_message(&self) -> Result<Option<GetMessageResult>, Error>

Get a single message from the Queue.

Returns None if there was no messages.

---

Example Usage:

let queue: Queue = ...;

while let Some(
    GetMessageResult {
       message,
       delivery_tag,
    }
) = queue.get_message.await? {
    ...
}

pub async fn acknowledge_message(&self, delivery_tag: u64) -> Result<(), Error>

Acknowledge a gotten message.

---

Example Usage:

let queue: Queue = ...;

while let Some(
    GetMessageResult {
       message,
       delivery_tag,
    }
) = queue.get_message.await? {
    queue.acknowledge_message(delivery_tag).await?;
}

pub async fn no_acknowledge_message( &self, requeue: bool, delivery_tag: u64 ) -> Result<(), Error>

No Acknowledge a gotten message.

Add requeue to true, to requeue the message.

---

Example Usage:

let queue: Queue = ...;

while let Some(
    GetMessageResult {
       message,
       delivery_tag,
    }
) = queue.get_message.await? {
    ... Some issue processing the message

    queue.no_acknowledge_message(true, delivery_tag).await?;
}

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Queue

Returns a copy of the value.

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

Performs copy-assignment from source.