Struct RemoveMembersFromConsumerGroupOptions 

pub struct RemoveMembersFromConsumerGroupOptions { /* private fields */ }

Options for Admin::remove_members_from_consumer_group. Carries the members to be removed from the consumer group.

Corresponds to org.apache.kafka.clients.admin.RemoveMembersFromConsumerGroupOptions.

Implementations

impl RemoveMembersFromConsumerGroupOptions

pub fn new( members: impl IntoIterator<Item = MemberToRemove>, ) -> Result<Self, Error>

Creates options for removing the given members.

Mirrors Java’s RemoveMembersFromConsumerGroupOptions(Collection<MemberToRemove>).

Errors

Returns an error (Java’s IllegalArgumentException) if members is empty. Use Default::default to remove all members instead.

pub fn set_reason(&mut self, reason: impl Into<String>)

Sets an optional reason.

Mirrors Java’s reason(String).

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

Set the operation timeout in milliseconds (or None for the default).

pub fn members(&self) -> &HashSet<MemberToRemove>

The members to remove.

Mirrors Java’s members().

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

The optional reason.

Mirrors Java’s reason().

pub fn remove_all(&self) -> bool

Whether all members should be removed (i.e. no specific members were provided).

Mirrors Java’s removeAll().

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

The operation timeout in milliseconds, or None for the default.

Trait Implementations

impl Clone for RemoveMembersFromConsumerGroupOptions

fn clone(&self) -> RemoveMembersFromConsumerGroupOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoveMembersFromConsumerGroupOptions

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

Formats the value using the given formatter.

impl Default for RemoveMembersFromConsumerGroupOptions

fn default() -> RemoveMembersFromConsumerGroupOptions

Returns the “default value” for a type.

impl PartialEq for RemoveMembersFromConsumerGroupOptions

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

impl StructuralPartialEq for RemoveMembersFromConsumerGroupOptions