confluent_kafka/admin/
group_listing.rs1use crate::common::{GroupState, GroupType};
18
19#[derive(Clone, Debug, PartialEq, Eq, Hash)]
21#[doc(alias = "org.apache.kafka.clients.admin.GroupListing")]
22pub struct GroupListing {
23 group_id: String,
24 group_type: Option<GroupType>,
25 protocol: String,
26 group_state: Option<GroupState>,
27}
28
29impl GroupListing {
30 #[doc(alias = "org.apache.kafka.clients.admin.GroupListing#GroupListing")]
39 pub fn new(
40 group_id: impl Into<String>,
41 group_type: Option<GroupType>,
42 protocol: impl Into<String>,
43 group_state: Option<GroupState>,
44 ) -> Self {
45 Self { group_id: group_id.into(), group_type, protocol: protocol.into(), group_state }
46 }
47
48 #[doc(alias = "org.apache.kafka.clients.admin.GroupListing#groupId")]
54 pub fn group_id(&self) -> &str {
55 &self.group_id
56 }
57
58 #[doc(alias = "org.apache.kafka.clients.admin.GroupListing#type")]
69 pub fn r#type(&self) -> Option<GroupType> {
70 self.group_type
71 }
72
73 #[doc(alias = "org.apache.kafka.clients.admin.GroupListing#protocol")]
79 pub fn protocol(&self) -> &str {
80 &self.protocol
81 }
82
83 #[doc(alias = "org.apache.kafka.clients.admin.GroupListing#groupState")]
92 pub fn group_state(&self) -> Option<GroupState> {
93 self.group_state
94 }
95
96 #[doc(alias = "org.apache.kafka.clients.admin.GroupListing#isSimpleConsumerGroup")]
98 pub fn is_simple_consumer_group(&self) -> bool {
99 self.group_type == Some(GroupType::Classic) && self.protocol.is_empty()
100 }
101}
102
103impl std::fmt::Display for GroupListing {
104 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
105 write!(
106 f,
107 "(groupId='{}', type={}, protocol='{}', groupState={})",
108 self.group_id,
109 self.group_type.map_or_else(|| "none".to_string(), |t| t.to_string()),
110 self.protocol,
111 self.group_state.map_or_else(|| "none".to_string(), |s| s.to_string()),
112 )
113 }
114}
115
116#[cfg(test)]
117mod tests {
118 use super::*;
119 use crate::consumer::internals::ConsumerProtocol;
120
121 const GROUP_ID: &str = "mygroup";
122
123 #[test]
125 #[doc(alias = "org.apache.kafka.clients.admin.GroupListingTest#testSimpleConsumerGroup")]
126 fn test_simple_consumer_group() {
127 let gl = GroupListing::new(GROUP_ID, Some(GroupType::Classic), "", Some(GroupState::Empty));
128 assert!(gl.is_simple_consumer_group());
129
130 let gl = GroupListing::new(
131 GROUP_ID,
132 Some(GroupType::Classic),
133 ConsumerProtocol::PROTOCOL_TYPE,
134 Some(GroupState::Stable),
135 );
136 assert!(!gl.is_simple_consumer_group());
137
138 let gl = GroupListing::new(GROUP_ID, Some(GroupType::Consumer), "", Some(GroupState::Empty));
139 assert!(!gl.is_simple_consumer_group());
140
141 let gl = GroupListing::new(GROUP_ID, None, "", None);
142 assert!(!gl.is_simple_consumer_group());
143 }
144}