Struct CloseOptions 

pub struct CloseOptions { /* private fields */ }

Options for closing a consumer.

Corresponds to Java’s org.apache.kafka.clients.consumer.CloseOptions.

Implementations

impl CloseOptions

pub const DEFAULT_CLOSE_TIMEOUT_MS: u64 = 30_000

Default timeout (milliseconds) applied when CloseOptions::timeout is not set. In Java this constant lives in ConsumerUtils; we expose it here for now and a later phase will move it to its canonical location and re-export from there.

NOTE: Phase 6 will move this constant to a ConsumerUtils translation and re-export it here for backwards compatibility.

pub fn new_timeout(timeout: Duration) -> Self

Static method to create a CloseOptions with a custom timeout.

Corresponds to Java’s static CloseOptions.timeout(Duration). Java accepts a nullable Duration here and internally wraps it via Optional.ofNullable; Rust’s type system makes Duration non-null, so for “no timeout, use default” callers should use CloseOptions::default (or omit the call to new_timeout).

pub fn new_group_membership_operation( operation: GroupMembershipOperation, ) -> Self

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

Corresponds to Java’s static CloseOptions.groupMembershipOperation(GroupMembershipOperation).

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

Fluent setter for the close timeout.

Corresponds to Java’s CloseOptions.withTimeout(Duration) which accepts a nullable Duration. In Rust, Duration is non-null; the internal Option<Duration> field always becomes Some(timeout) after this call. Callers wanting “no timeout, use default” should leave the field at its default by skipping this setter (or via CloseOptions::default).

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

Fluent setter for the group membership operation upon shutdown.

In Java, this method rejects a null operation via Objects.requireNonNull. In Rust the type system makes the non-null guarantee redundant.

pub fn group_membership_operation(&self) -> GroupMembershipOperation

The group membership operation to apply upon shutdown.

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

The maximum time to wait for the close process to complete.

None means the default timeout will be used.

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.

impl PartialEq for CloseOptions

fn eq(&self, other: &CloseOptions) -> 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 CloseOptions

impl StructuralPartialEq for CloseOptions