Struct oracle::aq::DeqOptions

pub struct DeqOptions { /* private fields */ }

Options when dequeuing messages using advanced queueing

Warning: The type is unstable. It may be changed incompatibly by minor version upgrades.

Implementations

impl DeqOptions

pub fn condition(&self) -> Result<String>

Returns the condition that must be satisfied in order for a message to be dequeued.

See set_condition method for more information

pub fn consumer_name(&self) -> Result<String>

Returns the name of the consumer that is dequeuing messages.

see set_consumer_name method for more information.

pub fn correlation(&self) -> Result<String>

Returns the correlation of the message to be dequeued.

See set_correlation method for more information.

pub fn mode(&self) -> Result<DeqMode>

Returns the mode that is to be used when dequeuing messages.

pub fn message_id(&self) -> Result<Vec<u8>>

Returns the identifier of the specific message that is to be dequeued.

pub fn navigation(&self) -> Result<DeqNavigation>

Returns the position of the message that is to be dequeued.

pub fn transformation(&self) -> Result<String>

Returns the transformation of the message to be dequeued.

See set_transformation method for more information.

pub fn visibility(&self) -> Result<Visibility>

Returns whether the message being dequeued is part of the current transaction or constitutes a transaction on its own.

pub fn wait(&self) -> Result<Duration>

Returns the time to wait for a message matching the search criteria.

pub fn set_condition(&mut self, val: &str) -> Result<()>

Sets the condition which must be true for messages to be dequeued.

The condition must be a valid boolean expression similar to the where clause of a SQL query. The expression can include conditions on message properties, user data properties and PL/SQL or SQL functions. User data properties must be prefixed with tab.user_data as a qualifier to indicate the specific column of the queue table that stores the message payload.

pub fn set_consumer_name(&mut self, val: &str) -> Result<()>

Sets the name of the consumer which will be dequeuing messages. This value should only be set if the queue is set up for multiple consumers.

pub fn set_correlation(&mut self, val: &str) -> Result<()>

Sets the correlation of the message to be dequeued.

Special pattern matching characters such as the percent sign (%) and the underscore (_) can be used. If multiple messages satisfy the pattern, the order of dequeuing is undetermined.

pub fn set_delivery_mode(&mut self, val: &MessageDeliveryMode) -> Result<()>

Sets the message delivery mode that is to be used when dequeuing messages.

pub fn set_mode(&mut self, val: &DeqMode) -> Result<()>

Sets the mode that is to be used when dequeuing messages.

pub fn set_message_id(&mut self, val: &[u8]) -> Result<()>

Sets the identifier of the specific message to be dequeued.

pub fn set_navigation(&mut self, val: &DeqNavigation) -> Result<()>

Sets the position in the queue of the message that is to be dequeued.

pub fn set_transformation(&mut self, val: &str) -> Result<()>

Sets the transformation of the message to be dequeued.

The transformation is applied after the message is dequeued but before it is returned to the application. It must be created using DBMS_TRANSFORM.

pub fn set_visibility(&mut self, val: &Visibility) -> Result<()>

Sets whether the message being dequeued is part of the current transaction or constitutes a transaction on its own.

pub fn set_wait(&mut self, val: &Duration) -> Result<()>

Set the time to wait for a message matching the search criteria.

Trait Implementations

impl Debug for DeqOptions

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

Formats the value using the given formatter.