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 < 0 || version > 4 {
101            bail!("specified version not supported by this message type");
102        }
103        if version >= 4 {
104            types::CompactString.encode(buf, &self.group_id)?;
105        } else {
106            types::String.encode(buf, &self.group_id)?;
107        }
108        types::Int32.encode(buf, &self.generation_id)?;
109        if version >= 4 {
110            types::CompactString.encode(buf, &self.member_id)?;
111        } else {
112            types::String.encode(buf, &self.member_id)?;
113        }
114        if version >= 3 {
115            if version >= 4 {
116                types::CompactString.encode(buf, &self.group_instance_id)?;
117            } else {
118                types::String.encode(buf, &self.group_instance_id)?;
119            }
120        } else {
121            if !self.group_instance_id.is_none() {
122                bail!("A field is set that is not available on the selected protocol version");
123            }
124        }
125        if version >= 4 {
126            let num_tagged_fields = self.unknown_tagged_fields.len();
127            if num_tagged_fields > std::u32::MAX as usize {
128                bail!(
129                    "Too many tagged fields to encode ({} fields)",
130                    num_tagged_fields
131                );
132            }
133            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
134
135            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
136        }
137        Ok(())
138    }
139    fn compute_size(&self, version: i16) -> Result<usize> {
140        let mut total_size = 0;
141        if version >= 4 {
142            total_size += types::CompactString.compute_size(&self.group_id)?;
143        } else {
144            total_size += types::String.compute_size(&self.group_id)?;
145        }
146        total_size += types::Int32.compute_size(&self.generation_id)?;
147        if version >= 4 {
148            total_size += types::CompactString.compute_size(&self.member_id)?;
149        } else {
150            total_size += types::String.compute_size(&self.member_id)?;
151        }
152        if version >= 3 {
153            if version >= 4 {
154                total_size += types::CompactString.compute_size(&self.group_instance_id)?;
155            } else {
156                total_size += types::String.compute_size(&self.group_instance_id)?;
157            }
158        } else {
159            if !self.group_instance_id.is_none() {
160                bail!("A field is set that is not available on the selected protocol version");
161            }
162        }
163        if version >= 4 {
164            let num_tagged_fields = self.unknown_tagged_fields.len();
165            if num_tagged_fields > std::u32::MAX as usize {
166                bail!(
167                    "Too many tagged fields to encode ({} fields)",
168                    num_tagged_fields
169                );
170            }
171            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
172
173            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
174        }
175        Ok(total_size)
176    }
177}
178
179#[cfg(feature = "broker")]
180impl Decodable for HeartbeatRequest {
181    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
182        if version < 0 || version > 4 {
183            bail!("specified version not supported by this message type");
184        }
185        let group_id = if version >= 4 {
186            types::CompactString.decode(buf)?
187        } else {
188            types::String.decode(buf)?
189        };
190        let generation_id = types::Int32.decode(buf)?;
191        let member_id = if version >= 4 {
192            types::CompactString.decode(buf)?
193        } else {
194            types::String.decode(buf)?
195        };
196        let group_instance_id = if version >= 3 {
197            if version >= 4 {
198                types::CompactString.decode(buf)?
199            } else {
200                types::String.decode(buf)?
201            }
202        } else {
203            None
204        };
205        let mut unknown_tagged_fields = BTreeMap::new();
206        if version >= 4 {
207            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
208            for _ in 0..num_tagged_fields {
209                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
210                let size: u32 = types::UnsignedVarInt.decode(buf)?;
211                let unknown_value = buf.try_get_bytes(size as usize)?;
212                unknown_tagged_fields.insert(tag as i32, unknown_value);
213            }
214        }
215        Ok(Self {
216            group_id,
217            generation_id,
218            member_id,
219            group_instance_id,
220            unknown_tagged_fields,
221        })
222    }
223}
224
225impl Default for HeartbeatRequest {
226    fn default() -> Self {
227        Self {
228            group_id: Default::default(),
229            generation_id: 0,
230            member_id: Default::default(),
231            group_instance_id: None,
232            unknown_tagged_fields: BTreeMap::new(),
233        }
234    }
235}
236
237impl Message for HeartbeatRequest {
238    const VERSIONS: VersionRange = VersionRange { min: 0, max: 4 };
239    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
240}
241
242impl HeaderVersion for HeartbeatRequest {
243    fn header_version(version: i16) -> i16 {
244        if version >= 4 {
245            2
246        } else {
247            1
248        }
249    }
250}
kafka_protocol/messages/heartbeat_request.rs

kafka_protocol/messages/
heartbeat_request.rs
