kafka_protocol/messages/
describe_producers_request.rs

1//! DescribeProducersRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/DescribeProducersRequest.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
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct DescribeProducersRequest {
24    ///
25    ///
26    /// Supported API versions: 0
27    pub topics: Vec<TopicRequest>,
28
29    /// Other tagged fields
30    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
31}
32
33impl DescribeProducersRequest {
34    /// Sets `topics` to the passed value.
35    ///
36    ///
37    ///
38    /// Supported API versions: 0
39    pub fn with_topics(mut self, value: Vec<TopicRequest>) -> Self {
40        self.topics = value;
41        self
42    }
43    /// Sets unknown_tagged_fields to the passed value.
44    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
45        self.unknown_tagged_fields = value;
46        self
47    }
48    /// Inserts an entry into unknown_tagged_fields.
49    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
50        self.unknown_tagged_fields.insert(key, value);
51        self
52    }
53}
54
55#[cfg(feature = "client")]
56impl Encodable for DescribeProducersRequest {
57    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
58        if version != 0 {
59            bail!("specified version not supported by this message type");
60        }
61        types::CompactArray(types::Struct { version }).encode(buf, &self.topics)?;
62        let num_tagged_fields = self.unknown_tagged_fields.len();
63        if num_tagged_fields > std::u32::MAX as usize {
64            bail!(
65                "Too many tagged fields to encode ({} fields)",
66                num_tagged_fields
67            );
68        }
69        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
70
71        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
72        Ok(())
73    }
74    fn compute_size(&self, version: i16) -> Result<usize> {
75        let mut total_size = 0;
76        total_size += types::CompactArray(types::Struct { version }).compute_size(&self.topics)?;
77        let num_tagged_fields = self.unknown_tagged_fields.len();
78        if num_tagged_fields > std::u32::MAX as usize {
79            bail!(
80                "Too many tagged fields to encode ({} fields)",
81                num_tagged_fields
82            );
83        }
84        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
85
86        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
87        Ok(total_size)
88    }
89}
90
91#[cfg(feature = "broker")]
92impl Decodable for DescribeProducersRequest {
93    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
94        if version != 0 {
95            bail!("specified version not supported by this message type");
96        }
97        let topics = types::CompactArray(types::Struct { version }).decode(buf)?;
98        let mut unknown_tagged_fields = BTreeMap::new();
99        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
100        for _ in 0..num_tagged_fields {
101            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
102            let size: u32 = types::UnsignedVarInt.decode(buf)?;
103            let unknown_value = buf.try_get_bytes(size as usize)?;
104            unknown_tagged_fields.insert(tag as i32, unknown_value);
105        }
106        Ok(Self {
107            topics,
108            unknown_tagged_fields,
109        })
110    }
111}
112
113impl Default for DescribeProducersRequest {
114    fn default() -> Self {
115        Self {
116            topics: Default::default(),
117            unknown_tagged_fields: BTreeMap::new(),
118        }
119    }
120}
121
122impl Message for DescribeProducersRequest {
123    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
124    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
125}
126
127/// Valid versions: 0
128#[non_exhaustive]
129#[derive(Debug, Clone, PartialEq)]
130pub struct TopicRequest {
131    /// The topic name.
132    ///
133    /// Supported API versions: 0
134    pub name: super::TopicName,
135
136    /// The indexes of the partitions to list producers for.
137    ///
138    /// Supported API versions: 0
139    pub partition_indexes: Vec<i32>,
140
141    /// Other tagged fields
142    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
143}
144
145impl TopicRequest {
146    /// Sets `name` to the passed value.
147    ///
148    /// The topic name.
149    ///
150    /// Supported API versions: 0
151    pub fn with_name(mut self, value: super::TopicName) -> Self {
152        self.name = value;
153        self
154    }
155    /// Sets `partition_indexes` to the passed value.
156    ///
157    /// The indexes of the partitions to list producers for.
158    ///
159    /// Supported API versions: 0
160    pub fn with_partition_indexes(mut self, value: Vec<i32>) -> Self {
161        self.partition_indexes = value;
162        self
163    }
164    /// Sets unknown_tagged_fields to the passed value.
165    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
166        self.unknown_tagged_fields = value;
167        self
168    }
169    /// Inserts an entry into unknown_tagged_fields.
170    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
171        self.unknown_tagged_fields.insert(key, value);
172        self
173    }
174}
175
176#[cfg(feature = "client")]
177impl Encodable for TopicRequest {
178    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
179        if version != 0 {
180            bail!("specified version not supported by this message type");
181        }
182        types::CompactString.encode(buf, &self.name)?;
183        types::CompactArray(types::Int32).encode(buf, &self.partition_indexes)?;
184        let num_tagged_fields = self.unknown_tagged_fields.len();
185        if num_tagged_fields > std::u32::MAX as usize {
186            bail!(
187                "Too many tagged fields to encode ({} fields)",
188                num_tagged_fields
189            );
190        }
191        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
192
193        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
194        Ok(())
195    }
196    fn compute_size(&self, version: i16) -> Result<usize> {
197        let mut total_size = 0;
198        total_size += types::CompactString.compute_size(&self.name)?;
199        total_size += types::CompactArray(types::Int32).compute_size(&self.partition_indexes)?;
200        let num_tagged_fields = self.unknown_tagged_fields.len();
201        if num_tagged_fields > std::u32::MAX as usize {
202            bail!(
203                "Too many tagged fields to encode ({} fields)",
204                num_tagged_fields
205            );
206        }
207        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
208
209        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
210        Ok(total_size)
211    }
212}
213
214#[cfg(feature = "broker")]
215impl Decodable for TopicRequest {
216    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
217        if version != 0 {
218            bail!("specified version not supported by this message type");
219        }
220        let name = types::CompactString.decode(buf)?;
221        let partition_indexes = types::CompactArray(types::Int32).decode(buf)?;
222        let mut unknown_tagged_fields = BTreeMap::new();
223        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
224        for _ in 0..num_tagged_fields {
225            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
226            let size: u32 = types::UnsignedVarInt.decode(buf)?;
227            let unknown_value = buf.try_get_bytes(size as usize)?;
228            unknown_tagged_fields.insert(tag as i32, unknown_value);
229        }
230        Ok(Self {
231            name,
232            partition_indexes,
233            unknown_tagged_fields,
234        })
235    }
236}
237
238impl Default for TopicRequest {
239    fn default() -> Self {
240        Self {
241            name: Default::default(),
242            partition_indexes: Default::default(),
243            unknown_tagged_fields: BTreeMap::new(),
244        }
245    }
246}
247
248impl Message for TopicRequest {
249    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
250    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
251}
252
253impl HeaderVersion for DescribeProducersRequest {
254    fn header_version(version: i16) -> i16 {
255        2
256    }
257}