kafka_protocol/messages/
end_txn_response.rs

1//! EndTxnResponse
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/EndTxnResponse.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 EndTxnResponse {
24    /// The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.
25    ///
26    /// Supported API versions: 0-4
27    pub throttle_time_ms: i32,
28
29    /// The error code, or 0 if there was no error.
30    ///
31    /// Supported API versions: 0-4
32    pub error_code: i16,
33
34    /// Other tagged fields
35    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
36}
37
38impl EndTxnResponse {
39    /// Sets `throttle_time_ms` to the passed value.
40    ///
41    /// The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.
42    ///
43    /// Supported API versions: 0-4
44    pub fn with_throttle_time_ms(mut self, value: i32) -> Self {
45        self.throttle_time_ms = value;
46        self
47    }
48    /// Sets `error_code` to the passed value.
49    ///
50    /// The error code, or 0 if there was no error.
51    ///
52    /// Supported API versions: 0-4
53    pub fn with_error_code(mut self, value: i16) -> Self {
54        self.error_code = value;
55        self
56    }
57    /// Sets unknown_tagged_fields to the passed value.
58    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
59        self.unknown_tagged_fields = value;
60        self
61    }
62    /// Inserts an entry into unknown_tagged_fields.
63    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
64        self.unknown_tagged_fields.insert(key, value);
65        self
66    }
67}
68
69#[cfg(feature = "broker")]
70impl Encodable for EndTxnResponse {
71    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
72        types::Int32.encode(buf, &self.throttle_time_ms)?;
73        types::Int16.encode(buf, &self.error_code)?;
74        if version >= 3 {
75            let num_tagged_fields = self.unknown_tagged_fields.len();
76            if num_tagged_fields > std::u32::MAX as usize {
77                bail!(
78                    "Too many tagged fields to encode ({} fields)",
79                    num_tagged_fields
80                );
81            }
82            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
83
84            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
85        }
86        Ok(())
87    }
88    fn compute_size(&self, version: i16) -> Result<usize> {
89        let mut total_size = 0;
90        total_size += types::Int32.compute_size(&self.throttle_time_ms)?;
91        total_size += types::Int16.compute_size(&self.error_code)?;
92        if version >= 3 {
93            let num_tagged_fields = self.unknown_tagged_fields.len();
94            if num_tagged_fields > std::u32::MAX as usize {
95                bail!(
96                    "Too many tagged fields to encode ({} fields)",
97                    num_tagged_fields
98                );
99            }
100            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
101
102            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
103        }
104        Ok(total_size)
105    }
106}
107
108#[cfg(feature = "client")]
109impl Decodable for EndTxnResponse {
110    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
111        let throttle_time_ms = types::Int32.decode(buf)?;
112        let error_code = types::Int16.decode(buf)?;
113        let mut unknown_tagged_fields = BTreeMap::new();
114        if version >= 3 {
115            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
116            for _ in 0..num_tagged_fields {
117                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
118                let size: u32 = types::UnsignedVarInt.decode(buf)?;
119                let unknown_value = buf.try_get_bytes(size as usize)?;
120                unknown_tagged_fields.insert(tag as i32, unknown_value);
121            }
122        }
123        Ok(Self {
124            throttle_time_ms,
125            error_code,
126            unknown_tagged_fields,
127        })
128    }
129}
130
131impl Default for EndTxnResponse {
132    fn default() -> Self {
133        Self {
134            throttle_time_ms: 0,
135            error_code: 0,
136            unknown_tagged_fields: BTreeMap::new(),
137        }
138    }
139}
140
141impl Message for EndTxnResponse {
142    const VERSIONS: VersionRange = VersionRange { min: 0, max: 4 };
143    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
144}
145
146impl HeaderVersion for EndTxnResponse {
147    fn header_version(version: i16) -> i16 {
148        if version >= 3 {
149            1
150        } else {
151            0
152        }
153    }
154}
kafka_protocol/messages/end_txn_response.rs

kafka_protocol/messages/
end_txn_response.rs
