kafka_protocol/messages/
heartbeat_request.rs

1//! HeartbeatRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/HeartbeatRequest.json).
4// WARNING: the items of this module are generated and should not be edited directly
5#![allow(unused)]
6
7use std::borrow::Borrow;
8use std::collections::BTreeMap;
9
10use anyhow::{bail, Result};
11use bytes::Bytes;
12use uuid::Uuid;
13
14use crate::protocol::{
15    buf::{ByteBuf, ByteBufMut},
16    compute_unknown_tagged_fields_size, types, write_unknown_tagged_fields, Decodable, Decoder,
17    Encodable, Encoder, HeaderVersion, Message, StrBytes, VersionRange,
18};
19
20/// Valid versions: 0-4
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct HeartbeatRequest {
24    /// The group id.
25    ///
26    /// Supported API versions: 0-4
27    pub group_id: super::GroupId,
28
29    /// The generation of the group.
30    ///
31    /// Supported API versions: 0-4
32    pub generation_id: i32,
33
34    /// The member ID.
35    ///
36    /// Supported API versions: 0-4
37    pub member_id: StrBytes,
38
39    /// The unique identifier of the consumer instance provided by end user.
40    ///
41    /// Supported API versions: 3-4
42    pub group_instance_id: Option<StrBytes>,
43
44    /// Other tagged fields
45    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
46}
47
48impl HeartbeatRequest {
49    /// Sets `group_id` to the passed value.
50    ///
51    /// The group id.
52    ///
53    /// Supported API versions: 0-4
54    pub fn with_group_id(mut self, value: super::GroupId) -> Self {
55        self.group_id = value;
56        self
57    }
58    /// Sets `generation_id` to the passed value.
59    ///
60    /// The generation of the group.
61    ///
62    /// Supported API versions: 0-4
63    pub fn with_generation_id(mut self, value: i32) -> Self {
64        self.generation_id = value;
65        self
66    }
67    /// Sets `member_id` to the passed value.
68    ///
69    /// The member ID.
70    ///
71    /// Supported API versions: 0-4
72    pub fn with_member_id(mut self, value: StrBytes) -> Self {
73        self.member_id = value;
74        self
75    }
76    /// Sets `group_instance_id` to the passed value.
77    ///
78    /// The unique identifier of the consumer instance provided by end user.
79    ///
80    /// Supported API versions: 3-4
81    pub fn with_group_instance_id(mut self, value: Option<StrBytes>) -> Self {
82        self.group_instance_id = value;
83        self
84    }
85    /// Sets unknown_tagged_fields to the passed value.
86    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
87        self.unknown_tagged_fields = value;
88        self
89    }
90    /// Inserts an entry into unknown_tagged_fields.
91    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
92        self.unknown_tagged_fields.insert(key, value);
93        self
94    }
95}
96
97#[cfg(feature = "client")]
98impl Encodable for HeartbeatRequest {
99    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
100        if version >= 4 {
101            types::CompactString.encode(buf, &self.group_id)?;
102        } else {
103            types::String.encode(buf, &self.group_id)?;
104        }
105        types::Int32.encode(buf, &self.generation_id)?;
106        if version >= 4 {
107            types::CompactString.encode(buf, &self.member_id)?;
108        } else {
109            types::String.encode(buf, &self.member_id)?;
110        }
111        if version >= 3 {
112            if version >= 4 {
113                types::CompactString.encode(buf, &self.group_instance_id)?;
114            } else {
115                types::String.encode(buf, &self.group_instance_id)?;
116            }
117        } else {
118            if !self.group_instance_id.is_none() {
119                bail!("A field is set that is not available on the selected protocol version");
120            }
121        }
122        if version >= 4 {
123            let num_tagged_fields = self.unknown_tagged_fields.len();
124            if num_tagged_fields > std::u32::MAX as usize {
125                bail!(
126                    "Too many tagged fields to encode ({} fields)",
127                    num_tagged_fields
128                );
129            }
130            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
131
132            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
133        }
134        Ok(())
135    }
136    fn compute_size(&self, version: i16) -> Result<usize> {
137        let mut total_size = 0;
138        if version >= 4 {
139            total_size += types::CompactString.compute_size(&self.group_id)?;
140        } else {
141            total_size += types::String.compute_size(&self.group_id)?;
142        }
143        total_size += types::Int32.compute_size(&self.generation_id)?;
144        if version >= 4 {
145            total_size += types::CompactString.compute_size(&self.member_id)?;
146        } else {
147            total_size += types::String.compute_size(&self.member_id)?;
148        }
149        if version >= 3 {
150            if version >= 4 {
151                total_size += types::CompactString.compute_size(&self.group_instance_id)?;
152            } else {
153                total_size += types::String.compute_size(&self.group_instance_id)?;
154            }
155        } else {
156            if !self.group_instance_id.is_none() {
157                bail!("A field is set that is not available on the selected protocol version");
158            }
159        }
160        if version >= 4 {
161            let num_tagged_fields = self.unknown_tagged_fields.len();
162            if num_tagged_fields > std::u32::MAX as usize {
163                bail!(
164                    "Too many tagged fields to encode ({} fields)",
165                    num_tagged_fields
166                );
167            }
168            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
169
170            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
171        }
172        Ok(total_size)
173    }
174}
175
176#[cfg(feature = "broker")]
177impl Decodable for HeartbeatRequest {
178    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
179        let group_id = if version >= 4 {
180            types::CompactString.decode(buf)?
181        } else {
182            types::String.decode(buf)?
183        };
184        let generation_id = types::Int32.decode(buf)?;
185        let member_id = if version >= 4 {
186            types::CompactString.decode(buf)?
187        } else {
188            types::String.decode(buf)?
189        };
190        let group_instance_id = if version >= 3 {
191            if version >= 4 {
192                types::CompactString.decode(buf)?
193            } else {
194                types::String.decode(buf)?
195            }
196        } else {
197            None
198        };
199        let mut unknown_tagged_fields = BTreeMap::new();
200        if version >= 4 {
201            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
202            for _ in 0..num_tagged_fields {
203                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
204                let size: u32 = types::UnsignedVarInt.decode(buf)?;
205                let unknown_value = buf.try_get_bytes(size as usize)?;
206                unknown_tagged_fields.insert(tag as i32, unknown_value);
207            }
208        }
209        Ok(Self {
210            group_id,
211            generation_id,
212            member_id,
213            group_instance_id,
214            unknown_tagged_fields,
215        })
216    }
217}
218
219impl Default for HeartbeatRequest {
220    fn default() -> Self {
221        Self {
222            group_id: Default::default(),
223            generation_id: 0,
224            member_id: Default::default(),
225            group_instance_id: None,
226            unknown_tagged_fields: BTreeMap::new(),
227        }
228    }
229}
230
231impl Message for HeartbeatRequest {
232    const VERSIONS: VersionRange = VersionRange { min: 0, max: 4 };
233    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
234}
235
236impl HeaderVersion for HeartbeatRequest {
237    fn header_version(version: i16) -> i16 {
238        if version >= 4 {
239            2
240        } else {
241            1
242        }
243    }
244}
kafka_protocol/messages/heartbeat_request.rs

kafka_protocol/messages/
heartbeat_request.rs
