kafka_protocol/messages/
add_offsets_to_txn_request.rs

1//! AddOffsetsToTxnRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/AddOffsetsToTxnRequest.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 AddOffsetsToTxnRequest {
24    /// The transactional id corresponding to the transaction.
25    ///
26    /// Supported API versions: 0-4
27    pub transactional_id: super::TransactionalId,
28
29    /// Current producer id in use by the transactional id.
30    ///
31    /// Supported API versions: 0-4
32    pub producer_id: super::ProducerId,
33
34    /// Current epoch associated with the producer id.
35    ///
36    /// Supported API versions: 0-4
37    pub producer_epoch: i16,
38
39    /// The unique group identifier.
40    ///
41    /// Supported API versions: 0-4
42    pub group_id: super::GroupId,
43
44    /// Other tagged fields
45    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
46}
47
48impl AddOffsetsToTxnRequest {
49    /// Sets `transactional_id` to the passed value.
50    ///
51    /// The transactional id corresponding to the transaction.
52    ///
53    /// Supported API versions: 0-4
54    pub fn with_transactional_id(mut self, value: super::TransactionalId) -> Self {
55        self.transactional_id = value;
56        self
57    }
58    /// Sets `producer_id` to the passed value.
59    ///
60    /// Current producer id in use by the transactional id.
61    ///
62    /// Supported API versions: 0-4
63    pub fn with_producer_id(mut self, value: super::ProducerId) -> Self {
64        self.producer_id = value;
65        self
66    }
67    /// Sets `producer_epoch` to the passed value.
68    ///
69    /// Current epoch associated with the producer id.
70    ///
71    /// Supported API versions: 0-4
72    pub fn with_producer_epoch(mut self, value: i16) -> Self {
73        self.producer_epoch = value;
74        self
75    }
76    /// Sets `group_id` to the passed value.
77    ///
78    /// The unique group identifier.
79    ///
80    /// Supported API versions: 0-4
81    pub fn with_group_id(mut self, value: super::GroupId) -> Self {
82        self.group_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 AddOffsetsToTxnRequest {
99    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
100        if version >= 3 {
101            types::CompactString.encode(buf, &self.transactional_id)?;
102        } else {
103            types::String.encode(buf, &self.transactional_id)?;
104        }
105        types::Int64.encode(buf, &self.producer_id)?;
106        types::Int16.encode(buf, &self.producer_epoch)?;
107        if version >= 3 {
108            types::CompactString.encode(buf, &self.group_id)?;
109        } else {
110            types::String.encode(buf, &self.group_id)?;
111        }
112        if version >= 3 {
113            let num_tagged_fields = self.unknown_tagged_fields.len();
114            if num_tagged_fields > std::u32::MAX as usize {
115                bail!(
116                    "Too many tagged fields to encode ({} fields)",
117                    num_tagged_fields
118                );
119            }
120            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
121
122            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
123        }
124        Ok(())
125    }
126    fn compute_size(&self, version: i16) -> Result<usize> {
127        let mut total_size = 0;
128        if version >= 3 {
129            total_size += types::CompactString.compute_size(&self.transactional_id)?;
130        } else {
131            total_size += types::String.compute_size(&self.transactional_id)?;
132        }
133        total_size += types::Int64.compute_size(&self.producer_id)?;
134        total_size += types::Int16.compute_size(&self.producer_epoch)?;
135        if version >= 3 {
136            total_size += types::CompactString.compute_size(&self.group_id)?;
137        } else {
138            total_size += types::String.compute_size(&self.group_id)?;
139        }
140        if version >= 3 {
141            let num_tagged_fields = self.unknown_tagged_fields.len();
142            if num_tagged_fields > std::u32::MAX as usize {
143                bail!(
144                    "Too many tagged fields to encode ({} fields)",
145                    num_tagged_fields
146                );
147            }
148            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
149
150            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
151        }
152        Ok(total_size)
153    }
154}
155
156#[cfg(feature = "broker")]
157impl Decodable for AddOffsetsToTxnRequest {
158    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
159        let transactional_id = if version >= 3 {
160            types::CompactString.decode(buf)?
161        } else {
162            types::String.decode(buf)?
163        };
164        let producer_id = types::Int64.decode(buf)?;
165        let producer_epoch = types::Int16.decode(buf)?;
166        let group_id = if version >= 3 {
167            types::CompactString.decode(buf)?
168        } else {
169            types::String.decode(buf)?
170        };
171        let mut unknown_tagged_fields = BTreeMap::new();
172        if version >= 3 {
173            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
174            for _ in 0..num_tagged_fields {
175                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
176                let size: u32 = types::UnsignedVarInt.decode(buf)?;
177                let unknown_value = buf.try_get_bytes(size as usize)?;
178                unknown_tagged_fields.insert(tag as i32, unknown_value);
179            }
180        }
181        Ok(Self {
182            transactional_id,
183            producer_id,
184            producer_epoch,
185            group_id,
186            unknown_tagged_fields,
187        })
188    }
189}
190
191impl Default for AddOffsetsToTxnRequest {
192    fn default() -> Self {
193        Self {
194            transactional_id: Default::default(),
195            producer_id: (0).into(),
196            producer_epoch: 0,
197            group_id: Default::default(),
198            unknown_tagged_fields: BTreeMap::new(),
199        }
200    }
201}
202
203impl Message for AddOffsetsToTxnRequest {
204    const VERSIONS: VersionRange = VersionRange { min: 0, max: 4 };
205    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
206}
207
208impl HeaderVersion for AddOffsetsToTxnRequest {
209    fn header_version(version: i16) -> i16 {
210        if version >= 3 {
211            2
212        } else {
213            1
214        }
215    }
216}