Struct PurgeConfig

pub struct PurgeConfig { /* private fields */ }

Settings to provide to Producer::purge to parametrize the purge behavior

PurgeConfig::default() corresponds to a setting where nothing is purged.

Example

To purge both queued messages and in-flight messages:

let settings = PurgeConfig::default().queue().inflight();

Implementations

impl PurgeConfig

pub fn queue(self) -> Self

Purge messages in internal queues. This does not purge inflight messages.

pub fn inflight(self) -> Self

Purge messages in-flight to or from the broker. Purging these messages will void any future acknowledgements from the broker, making it impossible for the application to know if these messages were successfully delivered or not. Retrying these messages may lead to duplicates.

This does not purge messages in internal queues.

pub fn non_blocking(self) -> Self

Don’t wait for background thread queue purging to finish.

impl PurgeConfig

pub fn no_queue(self) -> Self

Unsets the flag set by queue

pub fn no_inflight(self) -> Self

Unsets the flag set by inflight

pub fn blocking(self) -> Self

Unsets the flag set by non_blocking

Trait Implementations

impl Clone for PurgeConfig

fn clone(&self) -> PurgeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PurgeConfig

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

Formats the value using the given formatter.

impl Default for PurgeConfig

fn default() -> PurgeConfig

Returns the “default value” for a type.

impl Copy for PurgeConfig