Struct CloseOptions 

pub struct CloseOptions { /* private fields */ }

Options for controlling the consumer close behavior.

This class allows customization of the close timeout and group membership operation when a consumer is being shut down.

Implementations

impl CloseOptions

pub fn new_with_timeout(timeout: Duration) -> Self

Static method to create a CloseOptions with a custom timeout.

Arguments

• timeout - The maximum time to wait for the consumer to close.

Returns

A new CloseOptions instance with the specified timeout.

Translation notes

timeout cannot be None: for the default timeout use CloseOptions::default.

pub fn with_operation(operation: GroupMembershipOperation) -> Self

Static method to create a CloseOptions with a specified group membership operation.

Arguments

• operation - The group membership operation to apply. Must be one of LEAVE_GROUP, REMAIN_IN_GROUP, or DEFAULT.

Returns

A new CloseOptions instance with the specified group membership operation.

pub fn with_timeout(self, timeout: Duration) -> Self

Fluent method to set the timeout for the close process.

Arguments

• timeout - The maximum time to wait for the consumer to close.

Returns

This CloseOptions instance.

Translation notes

timeout cannot be None: to keep the default timeout, do not call this method.

pub fn with_group_membership_operation( self, operation: GroupMembershipOperation, ) -> Self

Fluent method to set the group membership operation upon shutdown.

Arguments

• operation - The group membership operation to apply. Must be one of LEAVE_GROUP, REMAIN_IN_GROUP, or DEFAULT.

Returns

This CloseOptions instance.

pub fn group_membership_operation(&self) -> GroupMembershipOperation

Returns the group membership operation configured for this close.

Returns

The group membership operation

pub fn timeout(&self) -> Option<Duration>

Returns the timeout configured for this close.

Returns

The timeout, or None if using the default timeout

Trait Implementations

impl Clone for CloseOptions

fn clone(&self) -> CloseOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloseOptions

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

Formats the value using the given formatter.

impl Default for CloseOptions

fn default() -> Self

Returns the “default value” for a type.