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.

Implementations

impl RemoveMembersFromConsumerGroupOptions

pub fn new() -> Self

Creates options that remove every member of the group: remove_all() returns true.

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

Creates options for removing the given members.

Arguments

• members - the members to remove from the group; must not be empty.

Errors

• Error::is_local_illegal_argument_error if members is empty (“Invalid empty members has been provided”). Use Self::new to remove all members instead.

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

Sets an optional reason.

Arguments

• reason - the reason sent with the request, or None to clear a reason set earlier.

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 RemoveMembersFromConsumerGroupOptions instance.

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

Returns the members to remove, empty when all members are removed.

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

Returns the optional reason.

pub fn remove_all(&self) -> bool

Returns whether all members should be removed, as no specific members were provided.

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.

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.