Enum GroupState 

#[non_exhaustive]
pub enum GroupState {
    Unknown,
    PreparingRebalance,
    CompletingRebalance,
    Stable,
    Dead,
    Empty,
    Assigning,
    Reconciling,
    NotReady,
}

The group state.

The following table shows the correspondence between the group states and types.

State	Classic group	Consumer group	Share group	Streams group
UNKNOWN	Yes	Yes	Yes	Yes
PREPARING_REBALANCE	Yes	Yes
COMPLETING_REBALANCE	Yes	Yes
STABLE	Yes	Yes	Yes	Yes
DEAD	Yes	Yes	Yes	Yes
EMPTY	Yes	Yes	Yes	Yes
ASSIGNING		Yes		Yes
RECONCILING		Yes		Yes
NOT_READY				Yes

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown

An unrecognized group state (e.g. a state newer than this client).

PreparingRebalance

The group is preparing to rebalance.

CompletingRebalance

The group is completing a rebalance.

Stable

The group is stable.

Dead

The group is dead.

Empty

The group is empty.

Assigning

The group is assigning (consumer/streams groups only).

Reconciling

The group is reconciling (consumer/streams groups only).

NotReady

The group is not ready (streams groups only).

Implementations

impl GroupState

pub fn name(&self) -> &'static str

Returns the name of this enum constant, exactly as declared in Java (PREPARING_REBALANCE).

Java’s Enum.name(), which GroupState inherits. The text Java’s toString() returns (PreparingRebalance, the text the broker sends and parse reads) is this type’s Display.

pub fn parse(name: &str) -> Self

Case-insensitive group state lookup by string name.

Arguments

• name - the state name

Returns

The state, Unknown if unrecognized.

pub fn group_states_for_type(group_type: GroupType) -> HashSet<GroupState>

Returns the set of group states applicable to the given group type.

Arguments

• group_type - the group type

Panics

Panics with Group type not known if group_type is GroupType::Unknown, where Java throws IllegalArgumentException("Group type not known"). A group listing reports Unknown for a type this client does not know, such as one a newer broker added, so check for it before calling. The lookup otherwise always succeeds, so its signature stays a plain HashSet.

Trait Implementations

impl Clone for GroupState

fn clone(&self) -> GroupState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupState

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

Formats the value using the given formatter.

impl Display for GroupState

Java’s toString(), which returns the private name field: the text (PreparingRebalance) the broker sends and GroupState::parse reads, not the constant name GroupState::name returns (the constants of GroupState).

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

Formats the value using the given formatter.

impl Hash for GroupState

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 Ord for GroupState

fn cmp(&self, other: &GroupState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GroupState

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

fn partial_cmp(&self, other: &GroupState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for GroupState

impl Eq for GroupState

impl StructuralPartialEq for GroupState