Skip to main content

confluent_kafka/admin/
member_to_remove.rs

1// Copyright 2025 Confluent Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! A member to be removed from a consumer group.
16
17use crate::common::requests::JoinGroupRequest;
18use crate::leave_group_request_data::MemberIdentity;
19
20/// A struct containing information about the member to be removed.
21// Members are identified by their `group.instance.id` (static membership); the member id is left
22// as `JoinGroupRequest::UNKNOWN_MEMBER_ID` so the broker resolves it by instance id.
23#[derive(Clone, Debug, PartialEq, Eq, Hash)]
24#[doc(alias = "org.apache.kafka.clients.admin.MemberToRemove")]
25pub struct MemberToRemove {
26    group_instance_id: String,
27}
28
29impl MemberToRemove {
30    /// Creates a `MemberToRemove` for the given `group.instance.id`.
31    ///
32    /// # Arguments
33    ///
34    /// - `group_instance_id` - the `group.instance.id` of the member to remove.
35    #[doc(alias = "org.apache.kafka.clients.admin.MemberToRemove#MemberToRemove")]
36    pub fn new(group_instance_id: impl Into<String>) -> Self {
37        Self { group_instance_id: group_instance_id.into() }
38    }
39
40    /// Converts this member to a wire [`MemberIdentity`] (with an unknown member
41    /// id).
42    #[doc(alias = "org.apache.kafka.clients.admin.MemberToRemove#toMemberIdentity")]
43    pub(crate) fn to_member_identity(&self) -> MemberIdentity {
44        let mut identity = MemberIdentity::new();
45        identity
46            .set_group_instance_id(Some(self.group_instance_id.clone()))
47            .set_member_id(JoinGroupRequest::UNKNOWN_MEMBER_ID.to_string());
48        identity
49    }
50
51    /// Returns the `group.instance.id` of the member to remove.
52    #[doc(alias = "org.apache.kafka.clients.admin.MemberToRemove#groupInstanceId")]
53    pub fn group_instance_id(&self) -> &str {
54        &self.group_instance_id
55    }
56}
57
58#[cfg(test)]
59mod tests {
60    use super::*;
61
62    #[test]
63    fn equality_is_by_group_instance_id() {
64        assert_eq!(MemberToRemove::new("instance-1"), MemberToRemove::new("instance-1"));
65        assert_ne!(MemberToRemove::new("instance-1"), MemberToRemove::new("instance-2"));
66    }
67
68    #[test]
69    fn to_member_identity_sets_instance_and_unknown_member_id() {
70        let identity = MemberToRemove::new("instance-1").to_member_identity();
71        assert_eq!(identity.group_instance_id.as_deref(), Some("instance-1"));
72        assert_eq!(identity.member_id, JoinGroupRequest::UNKNOWN_MEMBER_ID);
73    }
74}