Struct amiquip::QueueDeclareOptions

pub struct QueueDeclareOptions {
    pub durable: bool,
    pub exclusive: bool,
    pub auto_delete: bool,
    pub arguments: FieldTable,
}

Options passed to the server when declaring a queue.

The default implementation sets all boolean fields to false and has an empty set of arguments.

Example

The arguments field can be used to declare a quorum queue:

let mut arguments = FieldTable::new();
arguments.insert(
    "x-queue-type".to_string(),
    AmqpValue::LongString("quorum".to_string()),
);
let options = QueueDeclareOptions {
    arguments,
    ..QueueDeclareOptions::default()
};

Fields

durable: bool

If true, declares queue as durable (survives server restarts); if false, declares queue as transient (will be deleted on a server restart).

exclusive: bool

If true, declares queue as exclusive: the queue may only be accessed by the current connection, and it will be deleted when the current connection is closed.

auto_delete: bool

If true, declares queue as auto-delete: the server will delete it once the last consumer is disconnected (either by cancellation or by its channel being closed).

NOTE: If a queue is declared as auto-delete but never has a consumer, it will not be deleted.

arguments: FieldTable

Extra arguments; these are optional in general, but may be needed for some plugins or server-specific features.

Trait Implementations

impl Clone for QueueDeclareOptions

fn clone(&self) -> QueueDeclareOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueueDeclareOptions

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

Formats the value using the given formatter.

impl Default for QueueDeclareOptions

fn default() -> QueueDeclareOptions

Returns the "default value" for a type.