Struct ListTransactionsOptions 

pub struct ListTransactionsOptions { /* private fields */ }

Options for Admin::list_transactions.

Implementations

impl ListTransactionsOptions

pub fn new() -> Self

Creates default options: no filters, and filtered_duration_ms == -1 (no duration filtering), matching Java’s defaults.

pub fn set_timeout_ms(self, timeout_ms: Option<i32>) -> Self

Set the timeout in milliseconds for this operation, or None if the default API timeout for the AdminClient should be used.

Arguments

• timeout_ms - the timeout in milliseconds, or None for the default API timeout.

Returns

This ListTransactionsOptions instance.

pub fn timeout_ms(&self) -> Option<i32>

Returns the timeout in milliseconds for this operation, or None if the default API timeout for the AdminClient should be used.

pub fn filter_states( self, states: impl IntoIterator<Item = TransactionState>, ) -> Self

Filter only the transactions that are in a specific set of states. If no filter is specified or if the passed set of states is empty, then transactions in all states will be returned.

Arguments

• states - the set of states to filter by

Returns

This ListTransactionsOptions instance.

pub fn filter_producer_ids( self, producer_ids: impl IntoIterator<Item = i64>, ) -> Self

Filter only the transactions from producers in a specific set of producer ids. If no filter is specified or if the passed collection of producer ids is empty, then the transactions of all producer ids will be returned.

Arguments

• producer_ids - the set of producer ids to filter by

Returns

This ListTransactionsOptions instance.

pub fn filter_on_duration(self, duration_ms: i64) -> Self

Filter only the transactions that are running longer than the specified duration. If no filter is specified or if the passed duration ms is less than 0, then the all transactions will be returned.

Arguments

• duration_ms - the duration in milliseconds to filter by

Returns

This ListTransactionsOptions instance.

pub fn filter_on_transactional_id_pattern(self, pattern: Option<String>) -> Self

Filter only the transactions that match with the given transactional ID pattern. If the filter is None or if the passed string is empty, then all the transactions will be returned.

Arguments

• pattern - the transactional ID regular expression pattern to filter by

Returns

This ListTransactionsOptions instance.

pub fn filtered_states(&self) -> &HashSet<TransactionState>

Returns the set of states to be filtered or empty if no states have been specified.

Returns

the current set of filtered states (empty means that no states are filtered and all transactions will be returned)

pub fn filtered_producer_ids(&self) -> &HashSet<i64>

Returns the set of producer ids that are being filtered or empty if none have been specified.

Returns

the current set of filtered producer ids (empty means that no producer ids are filtered and all transactions will be returned)

pub fn filtered_duration(&self) -> i64

Returns the duration ms value being filtered.

Returns

the current duration filter value in ms (negative value means transactions are not filtered by duration)

pub fn filtered_transactional_id_pattern(&self) -> Option<&str>

Returns transactional ID being filtered.

Returns

the current transactional ID pattern filter (empty means no transactional IDs are filtered and all transactions will be returned)

Trait Implementations

impl Clone for ListTransactionsOptions

fn clone(&self) -> ListTransactionsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListTransactionsOptions

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

Formats the value using the given formatter.

impl Default for ListTransactionsOptions

Java’s new ListTransactionsOptions(); a derived Default would set filtered_duration_ms to 0 instead of Java’s -1L (the initializer of ListTransactionsOptions#filteredDuration), and Admin::list_transactions() uses it.

fn default() -> Self

Returns the “default value” for a type.

impl Display for ListTransactionsOptions

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

Java’s toString(), the sets as Java’s [a, b] and an unset timeout or pattern as null.

Java prints its HashSets in hash order. That order is unspecified for the states, since an enum’s hash is its identity hash, so they print in declaration order. The producer ids print in ascending order, which is Java’s order for non-negative ids below the table size.

impl Hash for ListTransactionsOptions

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ListTransactionsOptions

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ListTransactionsOptions